PK_Encryptor Class Reference

Interface for public-key encryptors. More...

Inheritance diagram for PK_Encryptor:

List of all members.

Classes
class	InvalidPlaintextLength
	Exception thrown when trying to encrypt plaintext of invalid length. More...
Public Member Functions
virtual void	Encrypt (RandomNumberGenerator &rng, const byte *plaintext, size_t plaintextLength, byte *ciphertext, const NameValuePairs &parameters=g_nullNameValuePairs) const =0
	Encrypt a byte string.
virtual BufferedTransformation *	CreateEncryptionFilter (RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs &parameters=g_nullNameValuePairs) const
	Create a new encryption filter.
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
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

Interface for public-key encryptors.

Definition at line 2164 of file cryptlib.h.

---

Member Function Documentation

virtual void PK_Encryptor::Encrypt	(	RandomNumberGenerator &	rng,
		const byte *	plaintext,
		size_t	plaintextLength,
		byte *	ciphertext,
		const NameValuePairs &	parameters = g_nullNameValuePairs
	)			const [pure 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) != 0 ensures the plaintext isn't too large

COUNTOF(ciphertext) == CiphertextLength(plaintextLength) ensures the output byte buffer is large enough.

See also:

PK_Decryptor

Implemented in TF_EncryptorBase, DL_EncryptorBase< T >, and DL_EncryptorBase< SCHEME_OPTIONS::Element >.

Referenced by PK_DefaultEncryptionFilter::Put2().

BufferedTransformation * PK_Encryptor::CreateEncryptionFilter	(	RandomNumberGenerator &	rng,
		BufferedTransformation *	attachment = NULL,
		const NameValuePairs &	parameters = g_nullNameValuePairs
	)			const [virtual]

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 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 PK_Decryptor::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:

• cryptlib.h
• cryptlib.cpp