PK_Decryptor Class Reference

Interface for public-key decryptors. More...

Inheritance diagram for PK_Decryptor:
PK_CryptoSystem PrivateKeyAlgorithm AsymmetricAlgorithm Algorithm Clonable DL_CryptoSystemBase< PK_Decryptor, DL_PrivateKey< SCHEME_OPTIONS::Element > > DL_CryptoSystemBase< PK_Decryptor, DL_PrivateKey< T > > PK_FixedLengthCryptoSystemImpl< PK_Decryptor > DL_DecryptorBase< SCHEME_OPTIONS::Element > DL_DecryptorBase< T > TF_CryptoSystemBase< PK_Decryptor, TF_Base< TrapdoorFunctionInverse, PK_EncryptionMessageEncodingMethod > > AlgorithmImpl< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS::AlgorithmInfo > TF_DecryptorBase DL_ObjectImplBase< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey > AlgorithmImpl< TF_DecryptorBase, SCHEME_OPTIONS::AlgorithmInfo > DL_ObjectImpl< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey > TF_ObjectImplBase< TF_DecryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey > DL_DecryptorImpl< SCHEME_OPTIONS > TF_ObjectImpl< TF_DecryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey > TF_DecryptorImpl< SCHEME_OPTIONS >

List of all members.

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.
virtual BufferedTransformationCreateDecryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs &parameters=g_nullNameValuePairs) const
 create a new decryption filter
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
virtual size_t CiphertextLength (size_t 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 size_t FixedCiphertextLength () const
 return fixed ciphertext length, if one exists, otherwise return 0
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.
virtual ClonableClone () const
 Copies this object.

Detailed Description

Interface for public-key decryptors.

Definition at line 2197 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:
rng a RandomNumberGenerator derived class
ciphertext the encrypted byte buffer
ciphertextLength the size of the encrypted byte buffer
plaintext a byte buffer to hold the decrypted string
parameters additional 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 TF_DecryptorBase, DL_DecryptorBase< T >, and DL_DecryptorBase< SCHEME_OPTIONS::Element >.

Referenced by PK_DefaultDecryptionFilter::Put2().

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

Referenced by PK_DefaultDecryptionFilter::Put2().

virtual size_t PK_CryptoSystem::CiphertextLength ( size_t  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).

Referenced by PK_DefaultEncryptionFilter::Put2().

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

Referenced by FixedLengthDecrypt().

virtual std::string Algorithm::AlgorithmName (  )  const [inline, virtual, inherited]

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 Adler32, CCM_Base, CRC32, ClassNullRNG, AuthenticatedSymmetricCipher, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, EAX_Base, StreamTransformationFilter, HashFilter, HashVerificationFilter, AuthenticatedDecryptionFilter, SignerFilter, SignatureVerificationFilter, GCM_Base, HMAC< T >, RDRAND, RDSEED, SHA3, BitBucket, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

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

virtual Clonable* Clonable::Clone (  )  const [inline, virtual, inherited]

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:

Generated on 24 Mar 2016 for Crypto++ by  doxygen 1.6.1