Crypto++
Classes | Public Member Functions | List of all members
PK_Encryptor Class Referenceabstract

interface for public-key encryptors More...

#include <cryptlib.h>

Inheritance diagram for PK_Encryptor:
PK_CryptoSystem PublicKeyAlgorithm AsymmetricAlgorithm Algorithm Clonable DL_CryptoSystemBase< PK_Encryptor, DL_PublicKey< SCHEME_OPTIONS::Element > > DL_CryptoSystemBase< PK_Encryptor, DL_PublicKey< T > > PK_FixedLengthCryptoSystemImpl< PK_Encryptor > DL_EncryptorBase< SCHEME_OPTIONS::Element > DL_EncryptorBase< T > TF_CryptoSystemBase< PK_Encryptor, TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod > > AlgorithmImpl< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS::AlgorithmInfo > TF_EncryptorBase DL_ObjectImplBase< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey > AlgorithmImpl< TF_EncryptorBase, SCHEME_OPTIONS::AlgorithmInfo > DL_ObjectImpl< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey > TF_ObjectImplBase< TF_EncryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey > DL_EncryptorImpl< SCHEME_OPTIONS > TF_ObjectImpl< TF_EncryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey > TF_EncryptorImpl< SCHEME_OPTIONS >

Classes

class  InvalidPlaintextLength
 exception thrown when trying to encrypt plaintext of invalid length More...
 

Public Member Functions

virtual void Encrypt (RandomNumberGenerator &rng, const byte *plaintext, size_t plaintextLength, byte *ciphertext, const NameValuePairs &parameters=g_nullNameValuePairs) const =0
 encrypt a byte string More...
 
virtual BufferedTransformationCreateEncryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs &parameters=g_nullNameValuePairs) const
 create a new encryption filter More...
 
virtual size_t MaxPlaintextLength (size_t ciphertextLength) const =0
 maximum length of plaintext for a given ciphertext length More...
 
virtual size_t CiphertextLength (size_t plaintextLength) const =0
 calculate length of ciphertext given length of plaintext More...
 
virtual bool ParameterSupported (const char *name) const =0
 this object supports the use of the parameter with the given name More...
 
virtual size_t FixedCiphertextLength () const
 return fixed ciphertext length, if one exists, otherwise return 0 More...
 
virtual size_t FixedMaxPlaintextLength () const
 return maximum plaintext length given the fixed ciphertext length, if one exists, otherwise return 0
 
CryptoMaterialAccessMaterial ()
 returns a reference to the crypto material used by this object
 
const CryptoMaterialGetMaterial () const
 returns a const reference to the crypto material used by this object
 
virtual PublicKeyAccessPublicKey ()=0
 
virtual const PublicKeyGetPublicKey () const
 
void BERDecode (BufferedTransformation &bt)
 for backwards compatibility, calls AccessMaterial().Load(bt)
 
void DEREncode (BufferedTransformation &bt) const
 for backwards compatibility, calls GetMaterial().Save(bt)
 
virtual std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
 
virtual ClonableClone () const
 this is not implemented by most classes yet
 

Detailed Description

interface for public-key encryptors

Definition at line 1223 of file cryptlib.h.

Member Function Documentation

virtual void PK_Encryptor::Encrypt ( RandomNumberGenerator rng,
const byte *  plaintext,
size_t  plaintextLength,
byte *  ciphertext,
const NameValuePairs parameters = g_nullNameValuePairs 
) const
pure virtual

encrypt a byte string

Precondition
CiphertextLength(plaintextLength) != 0 (i.e., plaintext isn't too long)
size of ciphertext == CiphertextLength(plaintextLength)

Implemented in DL_EncryptorBase< T >, DL_EncryptorBase< SCHEME_OPTIONS::Element >, and TF_EncryptorBase.

virtual BufferedTransformation* PK_Encryptor::CreateEncryptionFilter ( RandomNumberGenerator rng,
BufferedTransformation attachment = NULL,
const NameValuePairs parameters = g_nullNameValuePairs 
) const
virtual

create a new encryption filter

Note
The caller is responsible for deleting the returned pointer.
Encoding parameters should be passed in the "EP" channel.
virtual size_t PK_CryptoSystem::MaxPlaintextLength ( size_t  ciphertextLength) const
pure virtualinherited

maximum length of plaintext for a given ciphertext length

Note
This function returns 0 if ciphertextLength is not valid (too long or too short).
virtual size_t PK_CryptoSystem::CiphertextLength ( size_t  plaintextLength) const
pure virtualinherited

calculate length of ciphertext given length of plaintext

Note
This function returns 0 if plaintextLength is not valid (too long).
virtual bool PK_CryptoSystem::ParameterSupported ( const char *  name) const
pure virtualinherited

this object supports the use of the parameter with the given name

some possible parameter names: EncodingParameters, KeyDerivationParameters

virtual size_t PK_CryptoSystem::FixedCiphertextLength ( ) const
inlinevirtualinherited

return fixed ciphertext length, if one exists, otherwise return 0

Note
"Fixed" here means length of ciphertext does not depend on length of plaintext. It usually does depend on the key length.

Definition at line 1211 of file cryptlib.h.

Referenced by PK_Decryptor::FixedLengthDecrypt().


The documentation for this class was generated from the following file: