glesys / butler-auth
Installs: 20 435
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 12
Forks: 2
Open Issues: 2
Requires
- php: ^8.2
- illuminate/bus: ^11.0
- illuminate/contracts: ^11.0
- illuminate/database: ^11.0
- illuminate/queue: ^11.0
- illuminate/support: ^11.0
Requires (Dev)
- laravel/pint: ^1.14
- mockery/mockery: ^1.6.9
- orchestra/testbench: ^9.0
- phpunit/phpunit: ^10.5.13
This package is auto-updated.
Last update: 2024-10-31 00:39:32 UTC
README
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
- Implement
Butler\Auth\Models\Contracts\HasAccessTokens
on your consumer model. - 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
// 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.