Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Classes | Public Member Functions | List of all members
PK_Encryptor Class Referenceabstract

Interface for public-key encryptors. More...

+ Inheritance diagram for PK_Encryptor:

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
 Provides the name of this algorithm. More...
 
virtual ClonableClone () const
 Copies this object. More...
 

Detailed Description

Interface for public-key encryptors.

Definition at line 2163 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.

Parameters
rnga RandomNumberGenerator derived class
plaintextthe plaintext byte buffer
plaintextLengththe size of the plaintext byte buffer
ciphertexta byte buffer to hold the encrypted string
parametersadditional configuration options
Precondition
CiphertextLength(plaintextLength) != 0 ensures the plaintext isn't too large
COUNTOF(ciphertext) == CiphertextLength(plaintextLength) ensures the output byte buffer is large enough.
See also
PK_Decryptor

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

Referenced by FixedRNG::GenerateBlock().

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 816 of file cryptlib.cpp.

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).

Referenced by FixedRNG::GenerateBlock().

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).

Referenced by FixedRNG::GenerateBlock().

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

virtual std::string Algorithm::AlgorithmName ( ) const
inlinevirtualinherited

Provides the name of this algorithm.

Returns
the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Note
AlgorithmName is not universally implemented yet

Reimplemented in AuthenticatedSymmetricCipher, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, ClassNullRNG, BitBucket, RDSEED, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, HMAC< T >, RDRAND, CRC32, GCM_Base, Adler32, EAX_Base, CCM_Base, SHA3, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by VariableRounds< 6, 2 >::StaticGetDefaultRounds().

virtual Clonable* Clonable::Clone ( ) const
inlinevirtualinherited

Copies this object.

Returns
a copy of this object
Exceptions
NotImplemented
Note
this is not implemented by most classes
See also
NotCopyable

Definition at line 464 of file cryptlib.h.


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