Trait CookieCryptTrait

Cookie Crypt Trait.

Provides the encrypt/decrypt logic for the CookieComponent.

Direct Known Users

Cake\Controller\Component\CookieComponent, Cake\TestSuite\IntegrationTestCase

Method Detail

_checkCiphersource protected

_checkCipher( string $encrypt )

Helper method for validating encryption cipher names.

Parameters

string $encrypt
The cipher name.

Throws

RuntimeException
When an invalid cipher is provided.

_decodesource protected

_decode( string $value , string|false $encrypt )

Decodes and decrypts a single value.

Parameters

string $value
The value to decode & decrypt.
string|false $encrypt
The encryption cipher to use.

Returns

string
Decoded value.

_decryptsource protected

_decrypt( array $values , string|boolean $mode )

Decrypts $value using public $type method in Security class

Parameters

array $values
Values to decrypt
string|boolean $mode
Encryption mode

Returns

string
decrypted string

_encryptsource protected

_encrypt( string $value , string|boolean $encrypt , string|null $key null )

Encrypts $value using public $type method in Security class

Parameters

string $value
Value to encrypt
string|boolean $encrypt
Encryption mode to use. False disabled encryption.
string|null $key optional null
Used as the security salt only in this time for tests if specified.

Returns

string
Encoded values

_explodesource protected

_explode( string $string )

Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().

Parameters

string $string
A string containing JSON encoded data, or a bare string.

Returns

array
Map of key and values

_getCookieEncryptionKeysource abstract protected

_getCookieEncryptionKey( )

Returns the encryption key to be used.

Returns

string
string

_implodesource protected

_implode( array $array )

Implode method to keep keys are multidimensional arrays

Parameters

array $array
Map of key and values

Returns

string
A json encoded string.

Properties summary

$_validCipherssource

protected array

Valid cipher names for encrypted cookies.

['aes', 'rijndael']

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Utility.CookieCryptTrait.html