TF_DecryptorBase Class Reference
Trapdoor function cryptosystems decryption base class. More...
Public Member Functions | |
| DecodingResult | Decrypt (RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs ¶meters=g_nullNameValuePairs) const |
| Decrypt a byte string. | |
| bool | ParameterSupported (const char *name) const |
| this object supports the use of the parameter with the given name | |
| size_t | FixedMaxPlaintextLength () const |
| return maximum plaintext length given the fixed ciphertext length, if one exists, otherwise return 0 | |
| size_t | FixedCiphertextLength () const |
| return fixed ciphertext length, if one exists, otherwise return 0 | |
| size_t | MaxPlaintextLength (size_t ciphertextLength) const |
| maximum length of plaintext for a given ciphertext length | |
| size_t | CiphertextLength (size_t plaintextLength) const |
| calculate length of ciphertext given length of plaintext | |
| virtual BufferedTransformation * | CreateDecryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs ¶meters=g_nullNameValuePairs) const |
| create a new decryption filter | |
| DecodingResult | FixedLengthDecrypt (RandomNumberGenerator &rng, const byte *ciphertext, byte *plaintext, const NameValuePairs ¶meters=g_nullNameValuePairs) const |
| decrypt a fixed size ciphertext | |
| CryptoMaterial & | AccessMaterial () |
| returns a reference to the crypto material used by this object | |
| const CryptoMaterial & | GetMaterial () const |
| returns a const reference to the crypto material used by this object | |
| virtual PrivateKey & | AccessPrivateKey ()=0 |
| virtual const PrivateKey & | GetPrivateKey () 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 Clonable * | Clone () const |
| Copies this object. | |
Detailed Description
Trapdoor function cryptosystems decryption base class.
Trapdoor function cryptosystems encryption base class.
Definition at line 296 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 [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
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().
| bool TF_CryptoSystemBase< PK_Decryptor , TF_Base< TrapdoorFunctionInverse, PK_EncryptionMessageEncodingMethod > >::ParameterSupported | ( | const char * | name | ) | const [inline, virtual, inherited] |
Implements PK_CryptoSystem.
| size_t TF_CryptoSystemBase< PK_Decryptor , TF_Base< TrapdoorFunctionInverse, PK_EncryptionMessageEncodingMethod > >::FixedCiphertextLength | ( | ) | const [inline, virtual, inherited] |
Implements PK_FixedLengthCryptoSystemImpl< PK_Decryptor >.
| size_t PK_FixedLengthCryptoSystemImpl< PK_Decryptor >::MaxPlaintextLength | ( | size_t | ciphertextLength | ) | const [inline, virtual, inherited] |
Implements PK_CryptoSystem.
| size_t PK_FixedLengthCryptoSystemImpl< PK_Decryptor >::CiphertextLength | ( | size_t | plaintextLength | ) | const [inline, virtual, inherited] |
Implements PK_CryptoSystem.
| BufferedTransformation * PK_Decryptor::CreateDecryptionFilter | ( | RandomNumberGenerator & | rng, | |
| BufferedTransformation * | attachment = NULL, |
|||
| const NameValuePairs & | parameters = g_nullNameValuePairs | |||
| ) | const [virtual, inherited] |
create a new decryption filter
- Note:
- caller is responsible for deleting the returned pointer
Definition at line 864 of file cryptlib.cpp.
| 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(), 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:
