Download the PHP package buzzingpixel/cookie-api without Composer
On this page you can find all versions of the php package buzzingpixel/cookie-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package cookie-api
BuzzingPixel Cookie API
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
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.
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
Save a cookie
Delete a cookie
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.
All versions of cookie-api with dependencies
ext-json Version *
ext-sodium Version *
buzzingpixel/corbomite-di Version ^1.0