ellipse / cookie-encryption
Psr-15 middleware allowing to encrypt cookies using defuse/php-encryption
Installs: 23 295
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 1
Requires
- php: >=7.3
- defuse/php-encryption: ^2.1
- dflydev/fig-cookies: ^3.0
- psr/http-message: ^1.0
- psr/http-server-handler: ^1.0
- psr/http-server-middleware: ^1.0
Requires (Dev)
- eloquent/phony-kahlan: ^4.0
- kahlan/kahlan: ^5.0
- laminas/laminas-diactoros: ^2.0
This package is auto-updated.
Last update: 2024-04-30 00:49:37 UTC
README
This package provides a Psr-15 middleware allowing to encrypt cookies using defuse/php-encryption.
Require php >= 7.3
Installation composer require ellipse/cookie-encryption
Run tests ./vendor/bin/kahlan
Getting started
This middleware takes an instance of Defuse\Crypto\Key from the defuse/php-encryption package and an array of bypassed cookie names as parameters. It will use defuse encryption mechanism to decrypt the cookies attached to the Psr-7 request and encrypt the cookies attached to the Psr-7 response. The cookies with a name in the bypassed array will stay untouched. When the decryption fails for one cookie, its value is set as an empty string.
<?php namespace App; use Defuse\Crypto\Key; use Ellipse\Cookies\EncryptCookiesMiddleware; // Load an encryption key from your config. $key = Key::loadFromAsciiSafeString(getenv('APP_KEY')); // By using this middleware all cookies will be decrypted/encrypted, except the one named 'bypassed'. $middleware = new EncryptCookiesMiddleware($key, ['bypassed']);