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

Interface for public-key decryptors. More...

+ Inheritance diagram for PK_Decryptor:

Public Member Functions

virtual DecodingResult Decrypt (RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs &parameters=g_nullNameValuePairs) const =0
 Decrypt a byte string. More...
 
virtual BufferedTransformationCreateDecryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs &parameters=g_nullNameValuePairs) const
 create a new decryption filter More...
 
DecodingResult FixedLengthDecrypt (RandomNumberGenerator &rng, const byte *ciphertext, byte *plaintext, const NameValuePairs &parameters=g_nullNameValuePairs) const
 decrypt a fixed size ciphertext
 
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 PrivateKeyAccessPrivateKey ()=0
 
virtual const PrivateKeyGetPrivateKey () 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 decryptors.

Definition at line 2196 of file cryptlib.h.

Member Function Documentation

virtual DecodingResult PK_Decryptor::Decrypt ( RandomNumberGenerator rng,
const byte *  ciphertext,
size_t  ciphertextLength,
byte *  plaintext,
const NameValuePairs parameters = g_nullNameValuePairs 
) const
pure virtual

Decrypt a byte string.

Parameters
rnga RandomNumberGenerator derived class
ciphertextthe encrypted byte buffer
ciphertextLengththe size of the encrypted byte buffer
plaintexta byte buffer to hold the decrypted string
parametersadditional configuration options
Returns
the result of the decryption operation
Precondition
COUNTOF(plaintext) == MaxPlaintextLength(ciphertextLength) ensures the output byte buffer is large enough

If DecodingResult::isValidCoding is true, then DecodingResult::messageLength is valid and holds the the actual length of the plaintext recovered. on success. The result is undefined if decryption failed. If DecodingResult::isValidCoding is false, then DecodingResult::messageLength is undefined.

See also
PK_Encryptor

Implemented in DL_DecryptorBase< T >, DL_DecryptorBase< SCHEME_OPTIONS::Element >, and TF_DecryptorBase.

Referenced by FixedRNG::GenerateBlock().

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

create a new decryption filter

Note
caller is responsible for deleting the returned pointer

Definition at line 864 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: