buzzingpixel/cookie-api

2.0.1 2019-03-27 01:30 UTC

This package is auto-updated.

Last update: 2022-07-27 08:57:02 UTC


README

68747470733a2f2f7472617669732d63692e6f72672f62757a7a696e67706978656c2f636f6f6b69652d6170692e7376673f6272616e63683d6d6173746572

Provides a an easy to use API and entity for dealing with cookies in PHP.

And it does stuff like encrypting cookie contents. While you shouldn't generally put things in cookies that should be kept secret, there are always attack vectors that could be exploited and encrypting cookie contents narrows attack vectors. For instance if you store the primary key of a database row in a cookie [which you probably shouldn't, but everyone has done it], and it then becomes easy to increment or decrement that number and spoof a cookie to provide access to something that user maybe shouldn't have access to.

And by using libsodium encryption, it ensures that cookie values cannot be tampered with.

Usage

ENCRYPTION_KEY environment variable

You must have an environment variable set called ENCRYPTION_KEY and it must be exactly 32 characters in length. This key should be kept SECRET at all times. It's the secret key and should never be revealed to the public or else your encrypted data can be read by anyone.

Creating a cookie entity

<?php
declare(strict_types=1);

use corbomite\di\Di;
use buzzingpixel\cookieapi\CookieApi;

/** @var CookieApi $cookieApi */
$cookieApi = Di::get('CookieApi');

// Make a cookie entity (same as new \buzzingpixel\cookieapi\Cookie) but more testable as method call
$cookie = $cookieApi->makeCookie('MyCookie', 'MyValue');

Note that the cookie entity is immutable. Therefore, in order to get a new cookie entity with a changed value, use the $newCookie = $cookie->withPropName($val) methods.

$newCookie = $cookie->withValue('myNewValue');

makeCookie() or Cookie::__construct() arguments

$name

Type: string. Required. The name of the cookie.

$value

Type: string. Required. The value of the cookie.

$expire

Type: DateTimeInterface class. Optional. Defaults to 20 years in future.

$path

Type: string. Optional. Defaults to / The cookie path.

$domain

Type: string. Optional. Defaults to empty. The domain for the cookie.

$secure

Type: boolean. Optional. Defaults to false.

$httpOnly

Type: boolean. Optional. Defaults to true.

Retrieving a cookie

<?php
declare(strict_types=1);

use corbomite\di\Di;
use buzzingpixel\cookieapi\CookieApi;

/** @var CookieApi $cookieApi */
$cookieApi = Di::get('CookieApi');

// Get a cookie by its name. Returns a `\buzzingpixel\cookieapi\Cookie` entity or null if no cookie by that name is set
$cookie = $cookieApi->retrieveCookie('MyCookie');

Save a cookie

<?php
declare(strict_types=1);

use corbomite\di\Di;
use buzzingpixel\cookieapi\CookieApi;

/** @var CookieApi $cookieApi */
$cookieApi = Di::get('CookieApi');

$cookie = $cookieApi->makeCookie('MyCookie', 'MyValue');

$cookieApi->saveCookie($cookie);

Delete a cookie

<?php
declare(strict_types=1);

use corbomite\di\Di;
use buzzingpixel\cookieapi\CookieApi;

/** @var CookieApi $cookieApi */
$cookieApi = Di::get('CookieApi');

// Delete a cookie by passing the cookie entity to be deleted
$cookie = $cookieApi->retrieveCookie('MyCookie');
$cookieApi->deleteCookie($cookie);

// Delete a cookie by name
$cookieApi->deleteCookieByName('MyCookie');

License

Copyright 2019 BuzzingPixel, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.