Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/cookies
Convenient way to use cookies with PSR-7
https://github.com/yiisoft/cookies
cookie cookies hacktoberfest psr-15 yii3
Last synced: about 1 month ago
JSON representation
Convenient way to use cookies with PSR-7
- Host: GitHub
- URL: https://github.com/yiisoft/cookies
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-09-11T15:43:55.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T07:20:48.000Z (7 months ago)
- Last Synced: 2024-04-15T02:59:37.228Z (7 months ago)
- Topics: cookie, cookies, hacktoberfest, psr-15, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 113 KB
- Stars: 21
- Watchers: 16
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Cookies
[](https://packagist.org/packages/yiisoft/cookies)
[](https://packagist.org/packages/yiisoft/cookies)
[](https://github.com/yiisoft/cookies/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/cookies)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cookies/master)
[](https://github.com/yiisoft/cookies/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/cookies)
The package helps in working with HTTP cookies in a [PSR-7](https://www.php-fig.org/psr/psr-7/) environment:
- provides a handy abstraction representing a cookie
- allows dealing with many cookies at once
- forms and adds `Set-Cookie` headers to response
- signs a cookie to prevent its value from being tampered with
- encrypts a cookie to prevent its value from being tampered with
- provides [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware for encrypting and signing cookie values
## Requirements
- PHP 7.4 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/cookies
```
## General usage
Adding a cookie to response:
```php
$cookie = (new \Yiisoft\Cookies\Cookie('cookieName', 'value'))
->withPath('/')
->withDomain('yiiframework.com')
->withHttpOnly(true)
->withSecure(true)
->withSameSite(\Yiisoft\Cookies\Cookie::SAME_SITE_STRICT)
->withMaxAge(new \DateInterval('P7D'));
$response = $cookie->addToResponse($response);
```
Modifying response cookies to be sent:
```php
$cookies = \Yiisoft\Cookies\CookieCollection::fromResponse($response);
$cookies->expire('login');
$response = $cookies->setToResponse($response);
```
Getting request cookies:
```php
$cookies = \Yiisoft\Cookies\CookieCollection::fromArray($request->getCookieParams());
```
Signing a cookie to prevent its value from being tampered with:
```php
$cookie = new \Yiisoft\Cookies\Cookie('identity', 'identityValue');
// The secret key used to sign and validate cookies.
$key = '0my1xVkjCJnD_q1yr6lUxcAdpDlTMwiU';
$signer = new \Yiisoft\Cookies\CookieSigner($key);
// Prefixes unique hash based on the value of the cookie and a secret key.
$signedCookie = $signer->sign($cookie);
// Validates and get backs the cookie with clean value.
$cookie = $signer->validate($signedCookie);
// Before validation, check if the cookie is signed.
if ($signer->isSigned($cookie)) {
$cookie = $signer->validate($cookie);
}
```
Encrypting a cookie to prevent its value from being tampered with:
```php
$cookie = new \Yiisoft\Cookies\Cookie('identity', 'identityValue');
// The secret key used to sign and validate cookies.
$key = '0my1xVkjCJnD_q1yr6lUxcAdpDlTMwiU';
$encryptor = new \Yiisoft\Cookies\CookieEncryptor($key);
// Encrypts cookie value based on the secret key.
$encryptedCookie = $encryptor->encrypt($cookie);
// Validates, decrypts and get backs the cookie with clean value.
$cookie = $encryptor->decrypt($encryptedCookie);
// Before decryption, check if the cookie is encrypted.
if ($encryptor->isEncrypted($cookie)) {
$cookie = $encryptor->decrypt($cookie);
}
```
Using a [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware to encrypt and sign cookie values.
```php
/**
* @var \Psr\Http\Message\ServerRequestInterface $request
* @var \Psr\Http\Server\RequestHandlerInterface $handler
* @var \Psr\Log\LoggerInterface $logger
*/
// The secret key used to sign and validate cookies.
$key = '0my1xVkjCJnD_q1yr6lUxcAdpDlTMwiU';
$signer = new \Yiisoft\Cookies\CookieSigner($key);
$encryptor = new \Yiisoft\Cookies\CookieEncryptor($key);
$cookiesSettings = [
'identity' => \Yiisoft\Cookies\CookieMiddleware::ENCRYPT,
'name_[1-9]' => \Yiisoft\Cookies\CookieMiddleware::SIGN,
'prefix*' => \Yiisoft\Cookies\CookieMiddleware::SIGN,
];
$middleware = new \Yiisoft\Cookies\CookieMiddleware(
$logger
$encryptor,
$signer,
$cookiesSettings,
);
// The cookie parameter values from the request are decrypted/validated.
// The cookie values are encrypted/signed, and appended to the response.
$response = $middleware->process($request, $handler);
```
Create cookie with raw value that will not be encoded:
```php
$cookie = (new \Yiisoft\Cookies\Cookie('cookieName'))
->withRawValue('ebaKUq90PhiHck_MR7st-E1SxhbYWiTsLo82mCTbNuAh7rgflx5LVsYfJJseyQCrODuVcJkTSYhm1WKte-l5lQ==')
```
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Cookies is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)