nigelgreenway/signa

A framework agnostic token generator

Signa

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

A framework agnostic token generator built for PHP 7. Uses scalar type hinting and return type hinting., _(*2)

Will generate a secure token using hash_hmac with access to the value and the expiry date of that token for use within your storage. An insecure token can also be generated with access to just a value, useful for a CSRF token., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require nigelgreenway/signa, <sub>(*5)</sub>

## Usage

```php
<?php

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

$tokenGenerator = new \Signa\TokenGenerator('s0m3-s3cur3-k3y');

$tokenWithExpiry = $tokenGenerator->tokenWithExpiry(
    [
        'user_name' => 'Scooby Doo',
        'age'       => 7,
    ],
    new \DateTimeImmutable('+30 Days'),
    'sha256'
);

// A secure token, for password resets and such
echo "A secure token\n";
echo sprintf("Value: %s\n", $tokenWithExpiry->value()); // Some hash string
echo sprintf("Expires on: %s\n", $tokenWithExpiry->expiresOn()->format('Y-m-d H:i:s')); // 30 days from today, aka the future

// An insecure token, generally CSRF and such
echo "\nAn insecure token\n";
$insecureToken = $tokenGenerator->token(36);
echo sprintf("Value: %s (Length %d)\n", $insecureToken->value(), strlen($insecureToken->value())); // Some string, 36 char length

echo "\nAn insecure token with odd value\n";
$insecureToken = $tokenGenerator->token(33);
echo sprintf("Value: %s (Length: %d)\n", $insecureToken->value(), strlen($insecureToken->value())); // Some string, 33 char length

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*6)</sub>

Testing

bash $ composer test, <sub>(*7)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*8)</sub>

Security

If you discover any security related issues, please email github@futurepixels.co.uk instead of using the issue tracker., <sub>(*9)</sub>

Credits

• Nigel Greenway
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>