<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crypto++: PK_CryptoSystem Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>PK_CryptoSystem Class Reference</h1><!-- doxytag: class="PK_CryptoSystem" -->
<p>interface for public-key encryptors and decryptors
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PK_CryptoSystem:</div>
<div class="dynsection">
<div class="center">
<img src="class_p_k___crypto_system.gif" usemap="#PK_CryptoSystem_map" alt=""/>
<map id="PK_CryptoSystem_map" name="PK_CryptoSystem_map">
<area href="class_p_k___decryptor.html" alt="PK_Decryptor" shape="rect" coords="769,56,1528,80"/>
<area href="class_p_k___encryptor.html" 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" 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" 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" 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" 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" 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" 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" alt="TF_DecryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="1538,448,2297,472"/>
<area href="class_t_f___encryptor_impl.html" alt="TF_EncryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="3845,448,4604,472"/>
</map>
</div>
</div>
<p><a href="class_p_k___crypto_system-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">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><td class="mdescLeft"> </td><td class="mdescRight">maximum length of plaintext for a given ciphertext length <a href="#aa4a3552c933a36b3aea26f31d00bee9b"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">calculate length of ciphertext given length of plaintext <a href="#abf04a4e08fb69a1a118bad3e998ef6a6"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">this object supports the use of the parameter with the given name <a href="#a294c4664af51a72112db1f04e6ef9049"></a><br/></td></tr>
<tr><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#ac803af974c9849eea17d73ac48b38566">FixedCiphertextLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return fixed ciphertext length, if one exists, otherwise return 0 <a href="#ac803af974c9849eea17d73ac48b38566"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a900d50ffe8e8956c4f2a7ec22d818603"></a><!-- doxytag: member="PK_CryptoSystem::FixedMaxPlaintextLength" ref="a900d50ffe8e8956c4f2a7ec22d818603" args="() const " -->
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___crypto_system.html#a900d50ffe8e8956c4f2a7ec22d818603">FixedMaxPlaintextLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return maximum plaintext length given the fixed ciphertext length, if one exists, otherwise return 0 <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>Definition at line <a class="el" href="cryptlib_8h_source.html#l01205">1205</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa4a3552c933a36b3aea26f31d00bee9b"></a><!-- doxytag: member="PK_CryptoSystem::MaxPlaintextLength" ref="aa4a3552c933a36b3aea26f31d00bee9b" args="(size_t ciphertextLength) const =0" -->
<div class="memitem">
<div class="memproto">
<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<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>maximum length of plaintext for a given ciphertext length </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function returns 0 if ciphertextLength is not valid (too long or too short). </dd></dl>
<p>Referenced by <a class="el" href="cryptlib_8cpp_source.html#l00710">PK_DefaultDecryptionFilter::Put2()</a>.</p>
</div>
</div>
<a class="anchor" id="abf04a4e08fb69a1a118bad3e998ef6a6"></a><!-- doxytag: member="PK_CryptoSystem::CiphertextLength" ref="abf04a4e08fb69a1a118bad3e998ef6a6" args="(size_t plaintextLength) const =0" -->
<div class="memitem">
<div class="memproto">
<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<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>calculate length of ciphertext given length of plaintext </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function returns 0 if plaintextLength is not valid (too long). </dd></dl>
<p>Referenced by <a class="el" href="cryptlib_8cpp_source.html#l00665">PK_DefaultEncryptionFilter::Put2()</a>.</p>
</div>
</div>
<a class="anchor" id="a294c4664af51a72112db1f04e6ef9049"></a><!-- doxytag: member="PK_CryptoSystem::ParameterSupported" ref="a294c4664af51a72112db1f04e6ef9049" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<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<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>this object supports the use of the parameter with the given name </p>
<p>some possible parameter names: EncodingParameters, KeyDerivationParameters </p>
</div>
</div>
<a class="anchor" id="ac803af974c9849eea17d73ac48b38566"></a><!-- doxytag: member="PK_CryptoSystem::FixedCiphertextLength" ref="ac803af974c9849eea17d73ac48b38566" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t PK_CryptoSystem::FixedCiphertextLength </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return fixed ciphertext length, if one exists, otherwise return 0 </p>
<dl class="note"><dt><b>Note:</b></dt><dd>"Fixed" here means length of ciphertext does not depend on length of plaintext. It usually does depend on the key length. </dd></dl>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l01225">1225</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
<p>Referenced by <a class="el" href="cryptlib_8h_source.html#l01283">PK_Decryptor::FixedLengthDecrypt()</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>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
07dfcfe50d66c9a48a3c5e6c1693f12a
>
files
>
1043
