<!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++: PK_CryptoSystem 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_p_k___crypto_system-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PK_CryptoSystem Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for public-key encryptors and decryptors.
<a href="class_p_k___crypto_system.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 PK_CryptoSystem:</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_p_k___crypto_system.png" usemap="#PK_5FCryptoSystem_map" alt=""/>
<map id="PK_5FCryptoSystem_map" name="PK_5FCryptoSystem_map">
<area href="class_p_k___decryptor.html" title="Interface for public-key decryptors. " alt="PK_Decryptor" shape="rect" coords="769,56,1528,80"/>
<area href="class_p_k___encryptor.html" title="Interface for public-key encryptors. " alt="PK_Encryptor" shape="rect" coords="3076,56,3835,80"/>
<area href="class_d_l___crypto_system_base.html" alt="DL_CryptoSystemBase< PK_Decryptor, DL_PrivateKey< SCHEME_OPTIONS::Element > >" shape="rect" coords="0,112,759,136"/>
<area href="class_d_l___crypto_system_base.html" alt="DL_CryptoSystemBase< PK_Decryptor, DL_PrivateKey< T > >" shape="rect" coords="769,112,1528,136"/>
<area href="class_p_k___fixed_length_crypto_system_impl.html" alt="PK_FixedLengthCryptoSystemImpl< PK_Decryptor >" shape="rect" coords="1538,112,2297,136"/>
<area href="class_d_l___crypto_system_base.html" alt="DL_CryptoSystemBase< PK_Encryptor, DL_PublicKey< SCHEME_OPTIONS::Element > >" shape="rect" coords="2307,112,3066,136"/>
<area href="class_d_l___crypto_system_base.html" alt="DL_CryptoSystemBase< PK_Encryptor, DL_PublicKey< T > >" shape="rect" coords="3076,112,3835,136"/>
<area href="class_p_k___fixed_length_crypto_system_impl.html" alt="PK_FixedLengthCryptoSystemImpl< PK_Encryptor >" shape="rect" coords="3845,112,4604,136"/>
<area href="class_d_l___decryptor_base.html" alt="DL_DecryptorBase< SCHEME_OPTIONS::Element >" shape="rect" coords="0,168,759,192"/>
<area href="class_d_l___decryptor_base.html" title="Discrete Log (DL) decryptor base implementation. " alt="DL_DecryptorBase< T >" shape="rect" coords="769,168,1528,192"/>
<area href="class_t_f___crypto_system_base.html" alt="TF_CryptoSystemBase< PK_Decryptor, TF_Base< TrapdoorFunctionInverse, PK_EncryptionMessageEncodingMethod > >" shape="rect" coords="1538,168,2297,192"/>
<area href="class_d_l___encryptor_base.html" alt="DL_EncryptorBase< SCHEME_OPTIONS::Element >" shape="rect" coords="2307,168,3066,192"/>
<area href="class_d_l___encryptor_base.html" title="Discrete Log (DL) encryptor base implementation. " alt="DL_EncryptorBase< T >" shape="rect" coords="3076,168,3835,192"/>
<area href="class_t_f___crypto_system_base.html" alt="TF_CryptoSystemBase< PK_Encryptor, TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod > >" shape="rect" coords="3845,168,4604,192"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="0,224,759,248"/>
<area href="class_t_f___decryptor_base.html" title="Trapdoor function cryptosystems decryption base class. " alt="TF_DecryptorBase" shape="rect" coords="1538,224,2297,248"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="2307,224,3066,248"/>
<area href="class_t_f___encryptor_base.html" title="Trapdoor function cryptosystems encryption base class. " alt="TF_EncryptorBase" shape="rect" coords="3845,224,4604,248"/>
<area href="class_d_l___object_impl_base.html" alt="DL_ObjectImplBase< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="0,280,759,304"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< TF_DecryptorBase, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="1538,280,2297,304"/>
<area href="class_d_l___object_impl_base.html" alt="DL_ObjectImplBase< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey >" shape="rect" coords="2307,280,3066,304"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< TF_EncryptorBase, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="3845,280,4604,304"/>
<area href="class_d_l___object_impl.html" alt="DL_ObjectImpl< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="0,336,759,360"/>
<area href="class_t_f___object_impl_base.html" alt="TF_ObjectImplBase< TF_DecryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="1538,336,2297,360"/>
<area href="class_d_l___object_impl.html" alt="DL_ObjectImpl< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey >" shape="rect" coords="2307,336,3066,360"/>
<area href="class_t_f___object_impl_base.html" alt="TF_ObjectImplBase< TF_EncryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey >" shape="rect" coords="3845,336,4604,360"/>
<area href="class_d_l___decryptor_impl.html" title="Discrete Log (DL) decryptor implementation. " alt="DL_DecryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="0,392,759,416"/>
<area href="class_t_f___object_impl.html" alt="TF_ObjectImpl< TF_DecryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="1538,392,2297,416"/>
<area href="class_d_l___encryptor_impl.html" title="Discrete Log (DL) encryptor implementation. " alt="DL_EncryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="2307,392,3066,416"/>
<area href="class_t_f___object_impl.html" alt="TF_ObjectImpl< TF_EncryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey >" shape="rect" coords="3845,392,4604,416"/>
<area href="class_t_f___decryptor_impl.html" title="Trapdoor Function (TF) decryptor options. " alt="TF_DecryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="1538,448,2297,472"/>
<area href="class_t_f___encryptor_impl.html" title="Trapdoor Function (TF) encryptor options. " alt="TF_EncryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="3845,448,4604,472"/>
</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:aa4a3552c933a36b3aea26f31d00bee9b"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___crypto_system.html#aa4a3552c933a36b3aea26f31d00bee9b">MaxPlaintextLength</a> (size_t ciphertextLength) const =0</td></tr>
<tr class="memdesc:aa4a3552c933a36b3aea26f31d00bee9b"><td class="mdescLeft"> </td><td class="mdescRight">Provides the maximum length of plaintext for a given ciphertext length. <a href="#aa4a3552c933a36b3aea26f31d00bee9b">More...</a><br /></td></tr>
<tr class="separator:aa4a3552c933a36b3aea26f31d00bee9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf04a4e08fb69a1a118bad3e998ef6a6"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___crypto_system.html#abf04a4e08fb69a1a118bad3e998ef6a6">CiphertextLength</a> (size_t plaintextLength) const =0</td></tr>
<tr class="memdesc:abf04a4e08fb69a1a118bad3e998ef6a6"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the length of ciphertext given length of plaintext. <a href="#abf04a4e08fb69a1a118bad3e998ef6a6">More...</a><br /></td></tr>
<tr class="separator:abf04a4e08fb69a1a118bad3e998ef6a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a294c4664af51a72112db1f04e6ef9049"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___crypto_system.html#a294c4664af51a72112db1f04e6ef9049">ParameterSupported</a> (const char *name) const =0</td></tr>
<tr class="memdesc:a294c4664af51a72112db1f04e6ef9049"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this object supports the use of a named parameter. <a href="#a294c4664af51a72112db1f04e6ef9049">More...</a><br /></td></tr>
<tr class="separator:a294c4664af51a72112db1f04e6ef9049"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af415eacc974d297a03c4e7de710e5b4e"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___crypto_system.html#af415eacc974d297a03c4e7de710e5b4e">FixedCiphertextLength</a> () const</td></tr>
<tr class="memdesc:af415eacc974d297a03c4e7de710e5b4e"><td class="mdescLeft"> </td><td class="mdescRight">Provides the fixed ciphertext length, if one exists. <a href="#af415eacc974d297a03c4e7de710e5b4e">More...</a><br /></td></tr>
<tr class="separator:af415eacc974d297a03c4e7de710e5b4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a785f1a7390552faf18f9f91c6bc00429"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___crypto_system.html#a785f1a7390552faf18f9f91c6bc00429">FixedMaxPlaintextLength</a> () const</td></tr>
<tr class="memdesc:a785f1a7390552faf18f9f91c6bc00429"><td class="mdescLeft"> </td><td class="mdescRight">Provides the maximum plaintext length given a fixed ciphertext length. <a href="#a785f1a7390552faf18f9f91c6bc00429">More...</a><br /></td></tr>
<tr class="separator:a785f1a7390552faf18f9f91c6bc00429"><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 public-key encryptors and decryptors. </p>
<p>This class provides an interface common to encryptors and decryptors for querying their plaintext and ciphertext lengths. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02489">2489</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="aa4a3552c933a36b3aea26f31d00bee9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4a3552c933a36b3aea26f31d00bee9b">◆ </a></span>MaxPlaintextLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t PK_CryptoSystem::MaxPlaintextLength </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>ciphertextLength</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the maximum length of plaintext for a given ciphertext length. </p>
<dl class="section return"><dt>Returns</dt><dd>the maximum size of the plaintext, in bytes</dd></dl>
<p>This function returns 0 if ciphertextLength is not valid (too long or too short). </p>
</div>
</div>
<a id="abf04a4e08fb69a1a118bad3e998ef6a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf04a4e08fb69a1a118bad3e998ef6a6">◆ </a></span>CiphertextLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t PK_CryptoSystem::CiphertextLength </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>plaintextLength</em></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>Calculate the length of ciphertext given length of plaintext. </p>
<dl class="section return"><dt>Returns</dt><dd>the maximum size of the ciphertext, in bytes</dd></dl>
<p>This function returns 0 if plaintextLength is not valid (too long). </p>
</div>
</div>
<a id="a294c4664af51a72112db1f04e6ef9049"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a294c4664af51a72112db1f04e6ef9049">◆ </a></span>ParameterSupported()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool PK_CryptoSystem::ParameterSupported </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></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 this object supports the use of a named parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the name of the parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the parameter name is supported, false otherwise</dd></dl>
<p>Some possible parameter names: <a class="el" href="namespace_name.html#abfc2af8f8cc15abc866b9a48478c763f" title="ConstByteArrayParameter. ">EncodingParameters()</a>, <a class="el" href="namespace_name.html#a95aa7dfa33a469f783c9a988428927e9" title="ConstByteArrayParameter. ">KeyDerivationParameters()</a> and others Parameters listed in <a class="el" href="argnames_8h.html" title="Standard names for retrieving values by name when working with NameValuePairs. ">argnames.h</a> </p>
</div>
</div>
<a id="af415eacc974d297a03c4e7de710e5b4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af415eacc974d297a03c4e7de710e5b4e">◆ </a></span>FixedCiphertextLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t PK_CryptoSystem::FixedCiphertextLength </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 fixed ciphertext length, if one exists. </p>
<dl class="section return"><dt>Returns</dt><dd>the fixed ciphertext length if one exists, otherwise 0</dd></dl>
<p>"Fixed" here means length of ciphertext does not depend on length of plaintext. In this case, it usually does depend on the key length. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02515">2515</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a785f1a7390552faf18f9f91c6bc00429"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a785f1a7390552faf18f9f91c6bc00429">◆ </a></span>FixedMaxPlaintextLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t PK_CryptoSystem::FixedMaxPlaintextLength </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 maximum plaintext length given a fixed ciphertext length. </p>
<dl class="section return"><dt>Returns</dt><dd>maximum plaintext length given the fixed ciphertext length, if one exists, otherwise return 0.</dd></dl>
<p>FixedMaxPlaintextLength(0 returns the maximum plaintext length given the fixed ciphertext length, if one exists, otherwise return 0. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02522">2522</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:47 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
>
1363
