$_validCiphers
$_validCiphers : array
Valid cipher names for encrypted cookies.
Middlware for encrypting & decrypting cookies.
This middleware layer will encrypt/decrypt the named cookies with the given key and cipher type. To support multiple keys/cipher types use this middleware multiple times.
Cookies in request data will be decrypted, while cookies in response headers will
be encrypted automatically. If the response is a Cake\Http\Response, the cookie
data set with withCookie() and `cookie()`` will also be encrypted.
The encryption types and padding are compatible with those used by CookieComponent for backwards compatibility.
__construct(array $cookieNames, string $key, string $cipherType = 'aes')
Constructor
| array | $cookieNames | The list of cookie names that should have their values encrypted. |
| string | $key | The encryption key to use. |
| string | $cipherType | The cipher type to use. Defaults to 'aes', but can also be 'rijndael' for backwards compatibility. |
__invoke(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, callable $next) : \Psr\Http\Message\ResponseInterface
Apply cookie encryption/decryption.
| \Psr\Http\Message\ServerRequestInterface | $request | The request. |
| \Psr\Http\Message\ResponseInterface | $response | The response. |
| callable | $next | The next middleware to call. |
A response.
_encrypt(string $value, string|boolean $encrypt, string|null $key = null) : string
Encrypts $value using public $type method in Security class
| string | $value | Value to encrypt |
| string|boolean | $encrypt | Encryption mode to use. False disabled encryption. |
| string|null | $key | Used as the security salt if specified. |
Encoded values
_decrypt(array $values, string|boolean $mode, string|null $key = null) : string|array
Decrypts $value using public $type method in Security class
| array | $values | Values to decrypt |
| string|boolean | $mode | Encryption mode |
| string|null | $key | Used as the security salt if specified. |
Decrypted values
_decode(string $value, string|false $encrypt, string|null $key) : string|array
Decodes and decrypts a single value.
| 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. |
Decoded values.
_explode(string $string) : string|array
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
| string | $string | A string containing JSON encoded data, or a bare string. |
Map of key and values
decodeCookies(\Psr\Http\Message\ServerRequestInterface $request) : \Psr\Http\Message\ServerRequestInterface
Decode cookies from the request.
| \Psr\Http\Message\ServerRequestInterface | $request | The request to decode cookies from. |
Updated request with decoded cookies.
encodeCookies(\Cake\Http\Response $response) : \Cake\Http\Response
Encode cookies from a response's CookieCollection.
| \Cake\Http\Response | $response | The response to encode cookies in. |
Updated response with encoded cookies.
encodeSetCookieHeader(\Psr\Http\Message\ResponseInterface $response) : \Psr\Http\Message\ResponseInterface
Encode cookies from a response's Set-Cookie header
| \Psr\Http\Message\ResponseInterface | $response | The response to encode cookies in. |
Updated response with encoded cookies.
Loading…