https://github.com/attla/data-token
🪅 Turn everything into a token: randomized or predictable
https://github.com/attla/data-token
data-token data-transformation jwt jwt-token laravel laravel-package token tokenization tokenizer
Last synced: 4 months ago
JSON representation
🪅 Turn everything into a token: randomized or predictable
- Host: GitHub
- URL: https://github.com/attla/data-token
- Owner: attla
- License: mit
- Created: 2022-07-12T06:01:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-21T13:09:44.000Z (about 2 years ago)
- Last Synced: 2024-11-19T11:14:14.039Z (6 months ago)
- Topics: data-token, data-transformation, jwt, jwt-token, laravel, laravel-package, token, tokenization, tokenizer
- Language: PHP
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Data Token
🪅 Turn everything into a token: randomized or predictable.
## Installation
```bash
composer require attla/data-token
```
## Usage
Creating and managing a token
```php
use Attla\DataToken\Facade as DataToken;
// Create with facade
$token = DataToken::secrete('your secret phrase');
// Set the issuer claim
$token->iss();
// Set the expiration in minutes
$token->exp(120);
// Set payload of the token
$token->payload($model);
// Set the browser identifier on token
$token->bwr();
// Set user IP on the token
$token->ip();
// Get the token
$tokenEncoded = $token->encode();
```
Decoding the token
```php
// Get token value as associative array
$tokenValue = DataToken::decode($tokenEncoded, true);
// Aliases for decode a token
$tokenValue = DataToken::fromString($tokenEncoded);
$tokenValue = DataToken::parseString($tokenEncoded);
$tokenValue = DataToken::parse($tokenEncoded);
```
Others ways to make a token
```php
// Make a unique token from anything
$id = DataToken::id(123);
// Make always the same token
$sid = DataToken::sid(123);
// Make a strong token
$sign = DataToken::sign(123);
```
### List of message methods
| Method | Parameters | Description |
|--|--|--|
| ``encode()`` | - | Encode the token |
| ``decode(data, assoc)`` | String, Boolean | Decode the token, will be return false if as invalid |
| ``fromString(data, assoc)`` | String, Boolean | Alias for ``decode()`` |
| ``parseString(data, assoc)`` | String, Boolean | Alias for ``decode()`` |
| ``parse(data, assoc)`` | String, Boolean | Alias for ``decode()`` |
| ``iss()`` | - | Define the token issuer claim |
| ``exp(minutes)`` | Integer or CarbonInterface | Time to expire the token |
| ``payload(content)`` | Mixed | Set the content of the token, that can be a model, array, object, or anything, but can't be false |
| ``bwr()`` | - | Set the browser identifier to the token |
| ``ip()`` | - | Set the IP address from user to the token |
| ``body()`` | - | Alias for ``payload()`` |
| ``same()`` | - | Make the token always the same |
| ``sign(minutesExpiration)`` | Integer or CarbonInterface | Create a strong validation of the token |
| ``id(data)`` | Mixed | Generate a unique identifier of anything |
| ``sid(data)`` | - | Always generate the same identifier of anything |
| ``getEntropy()`` | - | Get entropy of the token |
## License
This package is licensed under the [MIT license](LICENSE) © [Octha](https://octha.com).