https://github.com/cable8mm/auth-by-key
API Key Authorization for Laravel & Nova
https://github.com/cable8mm/auth-by-key
apikey-authentication authorization composer-package laravel php8
Last synced: about 2 months ago
JSON representation
API Key Authorization for Laravel & Nova
- Host: GitHub
- URL: https://github.com/cable8mm/auth-by-key
- Owner: cable8mm
- License: mit
- Created: 2024-02-01T22:00:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T15:07:44.000Z (over 2 years ago)
- Last Synced: 2025-10-21T23:57:47.542Z (8 months ago)
- Topics: apikey-authentication, authorization, composer-package, laravel, php8
- Language: PHP
- Homepage: https://www.palgle.com/auth-by-key/
- Size: 135 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Auth By Key
[](https://github.com/cable8mm/auth-by-key/actions/workflows/code-style.yml)
[](https://github.com/cable8mm/auth-by-key/actions/workflows/run-tests.yml)
We are also able to use Laravel's first-party libraries for authorization, but it might not be lightweight. Yes, as a user Eloquent model, this can help with the problem. Only requests that pass through the 'auth-by-key' layer can proceed to the next stage through Laravel request.
We have provided the API Documentation on the web. For more information, please visit https://www.palgle.com/auth-by-key/ ❤️
## Installation
Run `composer require cable8mm/auth-by-key`.
Run the migrations
$ php artisan migrate
1 new database tables will be created:
- api_keys
## Managing Keys
Generate a new key using `php artisan apikey:generate {name}`. The name argument is the name of your API key. All new keys are active by default.
```bash
$ php artisan apikey:generate app1
// API key created
// Name: app1
// Key: 0ZdNlr7LrQocaqz74k6usQsOsqhqSIaUarSTf8mxnHuQVh9CvKAfpUy94VvBmFMq
```
Deactivate a key using `php artisan apikey:deactivate {name}`.
```bash
$ php artisan apikey:deactivate app1
// Deactivated key: app1
```
Activate a key using `php artisan apikey:activate {name}`.
```bash
$ php artisan apikey:activate app1
// Activated key: app1
```
Delete a key. You'll be asked to confirm. Keys are [soft-deleted](https://laravel.com/docs/eloquent#soft-deleting) for record keeping.
```bash
$ php artisan apikey:delete app1
// Are you sure you want to delete API key 'app1'? (yes/no) [no]:
// > yes
// Deleted key: app1
```
List all keys. The -D or --deleted flag includes deleted keys
```bash
$ php artisan apikey:list -D
// +----------+----+-------------+---------------------+------------------------------------------------------------------+
// | Name | ID | Status | Status Date | Key |
// +----------+----+-------------+---------------------+------------------------------------------------------------------+
// | app1 | 5 | deleted | 2017-11-03 13:54:51 | 0ZdNlr7LrQocaqz74k6usQsOsqhqSIaUarSTf8mxnHuQVh9CvKAfpUy94VvBmFMq |
// | app2 | 1 | deleted | 2017-11-02 22:34:28 | KuKMQbgZPv0PRC6GqCMlDQ7fgdamsVY75FrQvHfoIbw4gBaG5UX0wfk6dugKxrtW |
// | app3 | 3 | deactivated | 2017-11-02 23:12:34 | IrDlc7rSCvUzpZpW8jfhWaH235vJAqFwyzVWpoD0SLGzOimA6hcwqMvy4Nz6Hntn |
// | app4 | 2 | active | 2017-11-02 22:48:13 | KZEl4Y2HMuL013xvg6Teaa7zHPJhGy1TDhr2zWzlQCqTxqTzyPTcOV6fIQZVTIU3 |
// +----------+----+-------------+---------------------+------------------------------------------------------------------+
```
## Usage
### Implementing Authorization
A new `auth.apikey` route middleware has been registered for you to use in your routes or controllers. Below are examples on how to use middleware, but for detailed information, check out [Middleware](https://laravel.com/docs/middleware) in the Laravel Docs.
Route example
```php
Route::get('api/user/1', function () {
//
})->middleware('auth.apikey');
```
Controller example
```php
class UserController extends Controller
{
/**
* Instantiate a new controller instance.
*
* @return void
*/
public function __construct()
{
$this->middleware('auth.apikey');
}
}
```
### Authorizing Requests
In order to pass the `auth.apikey` middleware, requests must include an `X-Authorization` header as part of the request, with its value being an active API key.
X-Authorization: KuKMQbgZPv0PRC6GqCMlDQ7fgdamsVY75FrQvHfoIbw4gBaG5UX0wfk6dugKxrtW
## Unauthorized Requests
Requests that do not pass authorization will receive an HTTP 401 Status Code with the following response
```json
{
"errors": [
{
"message": "Unauthorized"
}
]
}
```
## Laravel Nova
Publish the nova resource file
```sh
php artisan vendor:publish --tag=auth-by-key-nova
```
If you will typically need to overwrite,
```sh
php artisan vendor:publish --tag=auth-by-key-nova --force
```
## Fix coding style
```sh
composer lint
```
## Test
```sh
composer test
```
## License
The Auth By Key package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).