TF_EncryptorBase Class Reference
Public Member Functions | |
| void | Encrypt (RandomNumberGenerator &rng, const byte *plaintext, size_t plaintextLength, byte *ciphertext, const NameValuePairs ¶meters=g_nullNameValuePairs) const |
| Encrypt 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 * | CreateEncryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs ¶meters=g_nullNameValuePairs) const |
| Create a new encryption filter. | |
| 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 PublicKey & | AccessPublicKey ()=0 |
| virtual const PublicKey & | GetPublicKey () 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
Definition at line 308 of file pubkey.h.
Member Function Documentation
| void TF_EncryptorBase::Encrypt | ( | RandomNumberGenerator & | rng, | |
| const byte * | plaintext, | |||
| size_t | plaintextLength, | |||
| byte * | ciphertext, | |||
| const NameValuePairs & | parameters = g_nullNameValuePairs | |||
| ) | const [virtual] |
Encrypt a byte string.
- Parameters:
-
rng a RandomNumberGenerator derived class plaintext the plaintext byte buffer plaintextLength the size of the plaintext byte buffer ciphertext a byte buffer to hold the encrypted string parameters additional configuration options
- Precondition:
CiphertextLength(plaintextLength) != 0ensures the plaintext isn't too large-
COUNTOF(ciphertext) == CiphertextLength(plaintextLength)ensures the output byte buffer is large enough.
- See also:
- PK_Decryptor
Implements PK_Encryptor.
Definition at line 153 of file pubkey.cpp.
References Algorithm::AlgorithmName(), IntToString(), and SecBlock< T, A >::size().
| bool TF_CryptoSystemBase< PK_Encryptor , TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod > >::ParameterSupported | ( | const char * | name | ) | const [inline, virtual, inherited] |
Implements PK_CryptoSystem.
| size_t TF_CryptoSystemBase< PK_Encryptor , TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod > >::FixedCiphertextLength | ( | ) | const [inline, virtual, inherited] |
Implements PK_FixedLengthCryptoSystemImpl< PK_Encryptor >.
| size_t PK_FixedLengthCryptoSystemImpl< PK_Encryptor >::MaxPlaintextLength | ( | size_t | ciphertextLength | ) | const [inline, virtual, inherited] |
Implements PK_CryptoSystem.
| size_t PK_FixedLengthCryptoSystemImpl< PK_Encryptor >::CiphertextLength | ( | size_t | plaintextLength | ) | const [inline, virtual, inherited] |
Implements PK_CryptoSystem.
| BufferedTransformation * PK_Encryptor::CreateEncryptionFilter | ( | RandomNumberGenerator & | rng, | |
| BufferedTransformation * | attachment = NULL, |
|||
| const NameValuePairs & | parameters = g_nullNameValuePairs | |||
| ) | const [virtual, inherited] |
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 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(), 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:
