Inheritance diagram for fpoirotte\Cryptal\Implementers\CryptoInterface:

Public Member Functions
	__construct (CipherEnum $cipher, ModeEnum $mode, PaddingInterface $padding, $key, $tagLength=self::DEFAULT_TAG_LENGTH)

	decrypt ($iv, $data, $tag=null, $aad= '')

	encrypt ($iv, $data, &$tag=null, $aad= '')

	getBlockSize ()

	getCipher ()

	getIVSize ()

	getKey ()

Detailed Description

Interface for encryption/decryption primitives.

Definition at line 13 of file CryptoInterface.php.

Constructor & Destructor Documentation

fpoirotte\Cryptal\Implementers\CryptoInterface::__construct	(	CipherEnum	$cipher,
		ModeEnum	$mode,
		PaddingInterface	$padding,
			$key,
			$tagLength = `self::DEFAULT_TAG_LENGTH`
	)

Construct a new encryption/decryption context.

Parameters

CipherEnum	$cipher	Cipher algorithm to use.
ModeEnum	$mode	Cryptography mode to apply to the cipher.
PaddingInterface	$padding	Padding scheme to use.
string	$key	Secret key used for encryption/decryption.
int	$tagLength	Length (in bytes) of the authentication tags to generate.

Note: The $tagLength parameter is unused unless the supplied mode supports Authenticated Encryption with Additional Data (AEAD).

fpoirotte\Cryptal\Implementers\CryptoInterface::decrypt	(	$iv,
		$data,
		$tag = `null`,
		$aad = `''`
	)

Decrypt some data.

Parameters

string	$iv	Initialization Vector for the operation.
string	$data	Data to decrypt.
string	$tag	Authentication tag.
string	$aad	Additional authenticated data.

Return values

string Plaintext (decrypted data).

Note: The $iv parameter is unused for some modes of operations (namely MODE_ECB). Still, this parameter is mandatory and an empty string may be passed for those modes.; An exception is thrown in case decryption fails, or the given authentication tag is incorrect (AEAD-only).; The $aad & $tag parameters are unused unless the required mode supports Authenticated Encryption with Additional Data (AEAD). MODE_GCM & MODE_EAX are known to support AEAD.

fpoirotte\Cryptal\Implementers\CryptoInterface::encrypt	(		$iv,
			$data,
		&	$tag = `null`,
			$aad = `''`
	)

Encrypt some data.

Parameters

string	$iv	Initialization Vector for the operation.
string	$data	Data to encrypt.
string	$tag	Variable where the generated tag will be stored.
string	$aad	Additional authenticated data.

Return values

string Ciphertext (encrypted data).

Note: The $iv parameter is unused for some modes of operations (namely MODE_ECB). Still, this parameter is mandatory and an empty string may be passed for those modes.; An exception is thrown in case encryption fails.; The $aad & $tag parameters are unused unless the required mode supports Authenticated Encryption with Additional Data (AEAD). MODE_GCM & MODE_EAX are known to support AEAD.

fpoirotte\Cryptal\Implementers\CryptoInterface::getBlockSize ( )

Get the block size, in bytes.

Return values