delboy1978uk/bone-paseto

Paseto package for Bone Framework

Maintainers

Details

github.com/delboy1978uk/bone-paseto

Source

Issues

Installs: 395

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

v1.1.0 2024-03-31 12:34 UTC

Requires

Requires (Dev)

MIT ae785dfba45fbaab085212cd38d015543f0db695

  • Derek Stephen McLean <delboy1978uk.woop@gmail.com>

This package is auto-updated.

Last update: 2024-12-01 00:08:14 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License
build status Code Coverage Scrutinizer Code Quality

bone-paseto

Platform agnostic security tokens for Bone Framework

installation

Use Composer

composer require delboy1978uk/bone-paseto

Simply add to the config/packages.php

<?php

// use statements here
use Bone\Paseto\PasetoPackage;

return [
    'packages' => [
        // packages here...,
        PasetoPackage::class,
    ],
    // ...
];

and add a config/ folder setting for bone-paseto with a 32 character sharedKey

<?php

return [
    'bone-paseto' => [
        'sharedKey' => 'tH1rtYtw0Ch4r4ct3rPasswordBlahXx',
    ],
];

usage

In your package class, you can call the service from the container and pass it into your controller or other classes.

$service = $c->get(Bone\Paseto\PasetoService::class);

encrypting and decrypting tokens

To encrypt a token, pass in the array of data and a string representation of a TimeInterval such as P01D.

$token = $this->paseto->encryptToken(['testing' => 123], 'P07D');
echo $token;

which will output

v2.local.c_0Nhh-hNPj5PYfZSANhI5TbJAD7MbEwxX8xBZcR1hzhtBOcAmtdTHdRKCTPGioxR0Qa8Bzs1f0xw1BsGgr2mjb6RjnECYTMXHFNbF5q86lkvqWqOxRPYIc

To decrypt a token, just pass it in!

$token = $this->paseto->decryptToken($bigLongTokenStringHere);
var_dump($token->getClaims());
array (size=2)
  'testing' => int 123
  'exp' => string '2020-12-27T07:46:22+00:00' (length=25)