Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

PK_Encryptor Class Reference

#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 > TwoBases< TF_EncryptorBase, PublicKeyCopier< SCHEME_OPTIONS::Keys > > DL_ObjectImpl< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey > AlgorithmImpl< TwoBases< TF_EncryptorBase, PublicKeyCopier< SCHEME_OPTIONS::Keys > >, SCHEME_OPTIONS::AlgorithmInfo > DL_PublicObjectImpl< DL_EncryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS > TF_ObjectImplBase< TwoBases< TF_EncryptorBase, PublicKeyCopier< SCHEME_OPTIONS::Keys > >, SCHEME_OPTIONS, PublicKeyCopier< SCHEME_OPTIONS::Keys >::KeyClass > DL_EncryptorImpl< SCHEME_OPTIONS > TF_ObjectImpl< TF_EncryptorBase, SCHEME_OPTIONS, PublicKeyCopier< SCHEME_OPTIONS::Keys > > TF_EncryptorImpl< SCHEME_OPTIONS > List of all members.

Detailed Description

interface for public-key encryptors

Definition at line 1141 of file cryptlib.h.

Public Member Functions

virtual void Encrypt (RandomNumberGenerator &rng, const byte *plaintext, unsigned int plaintextLength, byte *ciphertext, const NameValuePairs &parameters=g_nullNameValuePairs) const =0
 encrypt a byte string
virtual BufferedTransformationCreateEncryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs &parameters=g_nullNameValuePairs) const
 create a new encryption filter
virtual unsigned int MaxPlaintextLength (unsigned int ciphertextLength) const =0
 maximum length of plaintext for a given ciphertext length
virtual unsigned int CiphertextLength (unsigned int plaintextLength) const =0
 calculate length of ciphertext given length of plaintext
virtual bool ParameterSupported (const char *name) const =0
 this object supports the use of the parameter with the given name
virtual unsigned int FixedCiphertextLength () const
 return fixed ciphertext length, if one exists, otherwise return 0
virtual unsigned int 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


Member Function Documentation

virtual void PK_Encryptor::Encrypt RandomNumberGenerator rng,
const byte *  plaintext,
unsigned int  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 TF_EncryptorBase, DL_EncryptorBase< T >, and DL_EncryptorBase< SCHEME_OPTIONS::Element >.

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.

Definition at line 564 of file cryptlib.cpp.

virtual unsigned int PK_CryptoSystem::MaxPlaintextLength unsigned int  ciphertextLength  )  const [pure virtual, inherited]
 

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 unsigned int PK_CryptoSystem::CiphertextLength unsigned int  plaintextLength  )  const [pure virtual, inherited]
 

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 virtual, inherited]
 

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

some possible parameter names: EncodingParameters, KeyDerivationParameters

virtual unsigned int PK_CryptoSystem::FixedCiphertextLength  )  const [inline, virtual, inherited]
 

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 1129 of file cryptlib.h.

Referenced by TF_DecryptorBase::Decrypt(), and TF_EncryptorBase::Encrypt().


The documentation for this class was generated from the following files:
Generated on Wed Jul 21 19:16:01 2004 for Crypto++ by doxygen 1.3.7-20040704