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

Trapdoor function cryptosystems decryption base class. More...

+ Inheritance diagram for TF_DecryptorBase:

Public Member Functions

DecodingResult Decrypt (RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs &parameters=g_nullNameValuePairs) const
 Decrypt a byte string. More...
bool ParameterSupported (const char *name) const
size_t FixedMaxPlaintextLength () const
size_t FixedCiphertextLength () const
size_t MaxPlaintextLength (size_t ciphertextLength) const
size_t CiphertextLength (size_t plaintextLength) const
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
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

Trapdoor function cryptosystems decryption base class.

Trapdoor function cryptosystems encryption base class.

Definition at line 286 of file pubkey.h.

Member Function Documentation

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

Decrypt a byte string.

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
the result of the decryption operation
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

Implements PK_Decryptor.

Definition at line 140 of file pubkey.cpp.

References Algorithm::AlgorithmName(), Integer::ByteCount(), Integer::Encode(), IntToString(), SecBlock< T, A >::size(), and Integer::Zero().

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

create a new decryption filter

caller is responsible for deleting the returned pointer

Definition at line 864 of file cryptlib.cpp.

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

Provides the name of this algorithm.

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.

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

Referenced by BufferedTransformation::ChannelCreatePutSpace(), BufferedTransformation::ChannelFlush(), BufferedTransformation::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelPut2(), Decrypt(), TF_EncryptorBase::Encrypt(), StreamTransformation::ProcessLastBlock(), and PK_DefaultDecryptionFilter::Put2().

virtual Clonable* Clonable::Clone ( ) const

Copies this object.

a copy of this object
this is not implemented by most classes
See also

Definition at line 460 of file cryptlib.h.

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