Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.37 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.37 KB
Raw

.github/workflows/test.yml

Butler Auth

A minimal token authentication package inspired by Laravel Sanctum.

Installation

Requires a working Laravel app with a database connection, a queue worker and a cache store like redis or memcached.

composer require glesys/butler-auth

php artisan vendor:publish --tag=butler-auth-migrations
php artisan migrate

Generate token

  1. Implement Butler\Auth\Models\Contracts\HasAccessTokens on your consumer model.
  2. Use Butler\Auth\Models\Concerns\HasAccessTokens on your consumer model.
$token = $consumer->createToken(abilities: ['*'], name: 'my token')->plainTextToken;

Deleting tokens

Because of the caching that occurres when fetching access tokens, it is important to delete tokens through the model and not in the database directly.

// Delete access token by ID
AccessToken::find($id)->delete();

// Delete all tokens for a consumer
$consumer->tokens->map->delete();

Protecting Routes

See Laravels documentation.

// If "butler" is configured as your default guard
Route::view('/protected', 'protected')->middleware('auth');

// Or specify the guard
Route::view('/protected', 'protected')->middleware('auth:butler');

Authenticating

Pass the token in the Authorization header as a Bearer token.

Testing

vendor/bin/phpunit
vendor/bin/pint --test

How To Contribute

Development happens at GitHub; any typical workflow using Pull Requests are welcome. In the same spirit, we use the GitHub issue tracker for all reports (regardless of the nature of the report, feature request, bugs, etc.).

All changes are supposed to be covered by unit tests, if testing is impossible or very unpractical that warrants a discussion in the comments section of the pull request.

Code standard

As the library is intended for use in Laravel applications we encourage code standard to follow upstream Laravel practices - in short that would mean PSR-2 and PSR-4.