Trait CookieCryptTrait

Cookie Crypt Trait.

Provides the encrypt/decrypt logic for the CookieComponent.

Direct Users

Namespace: Cake\Utility
Link: https://book.cakephp.org/3.0/en/controllers/components/cookie.html
Location: Utility/CookieCryptTrait.php

Properties summary

  • $_validCiphers protected
    array
    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()source 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.

_decode()source protected 

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

Decodes 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

string|array
Decoded values.

_decrypt()source protected 

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

Decrypts $value using public $type method in Security class

Parameters

array $values
Values to decrypt
string|boolean $mode
Encryption mode
string|null $key optional null
Used as the security salt if specified.

Returns

string|array
Decrypted values

_encrypt()source 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 if specified.

Returns

string
Encoded values

_explode()source 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

string|array
Map of key and values

_getCookieEncryptionKey()source abstract protected 

_getCookieEncryptionKey( )

Returns the encryption key to be used.

Returns

string

_implode()source 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 detail

$_validCipherssource

protected array

Valid cipher names for encrypted cookies.

['aes', 'rijndael']

© 2005–2017 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.
https://api.cakephp.org/3.4/class-Cake.Utility.CookieCryptTrait.html