Download the PHP package tuupola/branca without Composer
On this page you can find all versions of the php package tuupola/branca. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tuupola/branca
More information about tuupola/branca
Files in tuupola/branca
Package branca
Short Description Authenticated and encrypted API tokens using modern crypto.
License MIT
Homepage https://github.com/tuupola/branca-php
Informations about the package branca
Branca Tokens for PHP
Authenticated and encrypted API tokens using modern crypto.
What?
Branca is a secure easy to use token format which makes it hard to shoot yourself in the foot. It uses IETF XChaCha20-Poly1305 AEAD symmetric encryption to create encrypted and tamperproof tokens. Payload itself is an arbitrary sequence of bytes. You can use for example a JSON object, plain text string or even binary data serialized by MessagePack or Protocol Buffers.
It is possible to use Branca as an alternative to JWT. There is also an authentication middleware for frameworks which support PSR-7 doublepass or PSR-15 standards.
Install
Install the library using Composer.
This branch requires PHP 7.2 or up. The older 1.x branch supports also PHP 5.6, 7.0 and 7.1.
Usage
Token payload can be any arbitrary data such as string containing an email address. You also must provide a 32 byte secret key. The key is used for encrypting the payload.
Sometimes you might prefer JSON.
You can keep the token size small by using a space efficient serialization method such as MessagePack or Protocol Buffers.
Timestamp
Branca token includes a timestamp when it was created. When decoding you can optionally pass a ttl
parameter. Value is passed in seconds. Below example throws en exception if token is older than 60 minutes.
Testing
You can run tests either manually or automatically on every code change. Automatic tests require entr to work.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
License
The MIT License (MIT). Please see License File for more information.