Trait CookieCryptTrait
Cookie Crypt Trait.
Provides the encrypt/decrypt logic for the CookieComponent.
Property Summary
-
$_validCiphers protected
array<string>Valid cipher names for encrypted cookies.
Method Summary
-
_checkCipher() protected
Helper method for validating encryption cipher names.
-
_decode() protected
Decodes and decrypts a single value.
-
_decrypt() protected
Decrypts $value using public $type method in Security class
-
_encrypt() protected
Encrypts $value using public $type method in Security class
-
_explode() protected
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
-
_getCookieEncryptionKey() abstract protected
Returns the encryption key to be used.
-
_implode() protected
Implode method to keep keys are multidimensional arrays
Method Detail
_checkCipher() ¶ protected
_checkCipher(string $encrypt): voidHelper method for validating encryption cipher names.
Parameters
-
string$encrypt The cipher name.
Returns
voidThrows
RuntimeExceptionWhen an invalid cipher is provided.
_decode() ¶ protected
_decode(string $value, string|false $encrypt, string|null $key): array|stringDecodes and decrypts a single value.
Parameters
-
string$value The value to decode & decrypt.
-
string|false$encrypt The encryption cipher to use.
-
string|null$key Used as the security salt if specified.
Returns
array|stringDecoded values.
_decrypt() ¶ protected
_decrypt(array<string>|string $values, string|false $mode, string|null $key = null): array|stringDecrypts $value using public $type method in Security class
Parameters
-
array<string>|string$values Values to decrypt
-
string|false$mode Encryption mode
-
string|null$key optional Used as the security salt if specified.
Returns
array|stringDecrypted values
_encrypt() ¶ protected
_encrypt(array|string $value, string|false $encrypt, string|null $key = null): stringEncrypts $value using public $type method in Security class
Parameters
-
array|string$value Value to encrypt
-
string|false$encrypt Encryption mode to use. False disabled encryption.
-
string|null$key optional Used as the security salt if specified.
Returns
stringEncoded values
_explode() ¶ protected
_explode(string $string): array|stringExplode 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|stringMap of key and values
_getCookieEncryptionKey() ¶ abstract protected
_getCookieEncryptionKey(): stringReturns the encryption key to be used.
Returns
string_implode() ¶ protected
_implode(array $array): stringImplode method to keep keys are multidimensional arrays
Parameters
-
array$array Map of key and values
Returns
stringA JSON encoded string.