Laravel-Tokenable

Easy creation of API Tokens for your Laravel models.

This package is aimed at those who want to build their own authentication systems. Or just need API Tokens for something small and don't want to pull in the entirity of laravel/passport for example.

It works by using a trait on whichever model(s) you wish to generate tokens for. The trait contains a one-to-many polymorphic relationship to the API Token model. It also contains a couple of helper functions which should be useful in utilising this package.

Installation

$ composer require stokoe/tokenable

Publish assets

$ php artisan vendor:publish --provider="Stokoe\TokenableServiceProvider"

Configuration

API Token length

Open up config/tokenable.php:

return [
	'token_length' => 60,
...

Set New Tokens As Primary On Creation

Open up config/tokenable.php:

return [
...
	'make_primary' => true,
...

Usage

Import the trait into your model and use it:

namespace App;

...
use Stokoe\Tokenable;

class User extends Authenticatable
{
	use Notifiable, Tokenable;
...

Now that model has a relationship called apiKey.

Generate new API Token for a given record.

Generate an API token for given record.

$user = App\User::first();
$user->generateApiToken();
// return ex: d96d7fb36e394c22bab8d4089f619752a3fe172effbdaad738d4276d81df72305373e207a7a91f8e18fc32cf1f9b6c6977d540f9a125c0746101d539

// You can also set token length at time of generation by passing an integer to the generate method.
$user->generateApiToken(12);
// return ex: 4bfc264da5337994341981a2

Get the API Tokens related to the record

Normally you'd find an API key by looking up users like:

$user = User::where('api_token', $token)->first();

or similar. In this case it's not so simple. There is a method provided but you may write your own inverse relationship. (Or improve mine and make a pull request!)

Here's how to find the model related to an API token.

$user = App\User::first();
$user->api_tokens; // Returns all API Tokens related to the user. (in this example)

$token = $request->input('token');
$relatedModel = $token->getRelatedModel(); // I don't like how this method works...

// return ex: d96d7fb36e394c22bab8d4089f619752a3fe172effbdaad738d4276d81df72305373e207a7a91f8e18fc32cf1f9b6c6977d540f9a125c0746101d539

Set an API Token as the primary token for that record

$user = User::first();
$user->api_tokens->sort('created_at', 'desc')->first()->setPrimary(true);

$user->generateApiToken(null, true); // Create an API token for that user, use the standard length (defined in config) and make it primary.

Michael-Stokoe / laravel-tokenable