Skip to content
Modern cookie management for PHP
Branch: master
Clone or download
Pull request Compare This branch is 4 commits ahead, 45 commits behind delight-im:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.editorconfig
.gitignore
LICENSE
Migration.md
README.md
composer.json
composer.lock

README.md

PHP-Cookie

This is a PHP7-only fork of Delight IM's Cookie library which uses the maximum level of security by default.

This means:

  • Secure is set to TRUE unless you override it.
  • HTTP-Only is set to TRUE unless you override it.
  • Same-Site is set to Strict unless you override it.

Modern cookie management for PHP

Requirements

  • PHP 7+

Installation

  • Install via Composer (recommended)

    $ composer require paragonie/cookie

    Include the Composer autoloader:

    require __DIR__.'/vendor/autoload.php';

  • or

  • Install manually

    • Copy the contents of the src directory to a subfolder of your project
    • Include the files in your code via require or require_once

Usage

Static method

This library provides a static method that is compatible to PHP's built-in setcookie(...) function but includes support for more recent features such as the SameSite attribute:

\ParagonIE\Cookie\Cookie::setcookie('SID', '31d4d96e407aad42');
// or
\ParagonIE\Cookie\Cookie::setcookie('SID', '31d4d96e407aad42', time() + 3600, '/~rasmus/', 'example.com', true, true, 'Lax');

Builder pattern

Instances of the Cookie class let you build a cookie conveniently by setting individual properties. This class uses reasonable defaults that may differ from defaults of the setcookie function.

$cookie = new \ParagonIE\Cookie\Cookie('SID');
$cookie->setValue('31d4d96e407aad42');
$cookie->setMaxAge(60 * 60 * 24);
// $cookie->setExpiryTime(time() + 60 * 60 * 24);
$cookie->setPath('/~rasmus/');
$cookie->setDomain('example.com');
$cookie->setHttpOnly(true);
$cookie->setSecureOnly(true);
$cookie->setSameSiteRestriction('Strict');
// echo $cookie;
$cookie->save();

The method calls can also be chained:

(new \ParagonIE\Cookie\Cookie('SID'))->setValue('31d4d96e407aad42')->setMaxAge(60 * 60 * 24)->setSameSiteRestriction('Strict')->save();

A cookie can later be deleted simply like this:

$cookie->delete();

Note: For the deletion to work, the cookie must have the same settings as the cookie that was originally saved. So you should remember to pass appropriate values to setPath(...), setDomain(...), setHttpOnly(...) and setSecureOnly(...) again.

Managing sessions

Using the Session class, you can start and resume sessions in a way that is compatible to PHP's built-in session_start() function, while having access to the improved cookie handling from this library as well:

// start session and have session cookie with 'lax' same-site restriction
\ParagonIE\Cookie\Session::start();
// or
\ParagonIE\Cookie\Session::start('Lax');

// start session and have session cookie with 'strict' same-site restriction
\ParagonIE\Cookie\Session::start('Strict');

// start session and have session cookie without any same-site restriction
\ParagonIE\Cookie\Session::start(null);

All three calls respect the settings from PHP's session_set_cookie_params(...) function and the configuration options session.name, session.cookie_lifetime, session.cookie_path, session.cookie_domain, session.cookie_secure, session.cookie_httponly and session.use_cookies.

Likewise, replacements for

session_regenerate_id();
// and
session_regenerate_id(true);

are available via

\ParagonIE\Cookie\Session::regenerate();
// and
\ParagonIE\Cookie\Session::regenerate(true);

if you want protection against session fixation attacks that comes with improved cookie handling.

Additionally, access to the current internal session ID is provided via

\ParagonIE\Cookie\Session::id();

as a replacement for

session_id();

Reading and writing session data

  • Read a value from the session (with optional default value):

    $value = \ParagonIE\Cookie\Session::get($key);
    // or
    $value = \ParagonIE\Cookie\Session::get($key, $defaultValue);
  • Write a value to the session:

    \ParagonIE\Cookie\Session::set($key, $value);
  • Check whether a value exists in the session:

    if (\ParagonIE\Cookie\Session::has($key)) {
        // ...
    }
  • Remove a value from the session:

    \ParagonIE\Cookie\Session::delete($key);
  • Read and then immediately remove a value from the session:

    $value = \ParagonIE\Cookie\Session::take($key);
    $value = \ParagonIE\Cookie\Session::take($key, $defaultValue);

    This is often useful for flash messages, e.g. in combination with the has(...) method.

Parsing cookies

$cookieHeader = 'Set-Cookie: test=php.net; expires=Thu, 09-Jun-2016 16:30:32 GMT; Max-Age=3600; path=/~rasmus/; secure';
$cookieInstance = \ParagonIE\Cookie\Cookie::parse($cookieHeader);

Specifications

Contributing

All contributions are welcome! If you wish to contribute, please create an issue first so that your feature, problem or question can be discussed.

License

This project is licensed under the terms of the MIT License.

You can’t perform that action at this time.