https://github.com/code16/machina
Machine to Machine Laravel authentication package based on JWT
https://github.com/code16/machina
Last synced: 6 months ago
JSON representation
Machine to Machine Laravel authentication package based on JWT
- Host: GitHub
- URL: https://github.com/code16/machina
- Owner: code16
- License: mit
- Created: 2018-03-08T15:56:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T13:40:54.000Z (11 months ago)
- Last Synced: 2025-05-13T11:56:33.599Z (9 months ago)
- Language: PHP
- Size: 47.9 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Machina
This package is a wrapper around `tymons\jwt-auth`, aimed at providing a simple & flexible machine-to-machine authentication for Laravel 5.5+.
## Installation
```
composer require code16/machina
```
## Configuration
If you want to customize some default options like the prefix used for `/login` and `/refresh` endpoints by the package, you can publish it to your application folder :
```
php artisan config:publish code16/machina
```
Then run this command, which will add a `JWT_SECRET` entry in your `.env` file:
```
php artisan jwt:secret
```
### Defining machine guard
In `config/auth.php` :
```php
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'machina' => [
'driver' => 'machina',
'provider' => Api\ClientRepository::class,
],
],
```
### Creating a `ClientRepository` class
This package does not come with an opinionated way of retrieving clients, but instead provides a very simple way to adapt it to your application, by providing a class implementing `Code16\Machina\ClientRepositoryInterface`.
Example :
```php
namespace App;
use Code16\Machina\ClientRepositoryInterface;
class ClientRepository implements ClientRepositoryInterface
{
public function findByKey($key)
{
return User::find($key);
}
public function findByCredentials($client, $secret)
{
return User::where('id', $client)->where('secret', $secret)->first();
}
}
```
Note that here we used the standard `App\User` model DB to identify our client, but you can use whichever model / fields you like.
## Protecting routes
```
Route::get('protected', 'ApiController@index')->middleware('auth:machina');
```
## Authenticating and retrieving token
Send a POST request the `/auth/login` endpoint with `client` and `secret` as parameters :
```
{
client : "1",
secret : "x7jfajleug64hggi"
}
```
If the credentials are correct, the API will return a JWT token that can be used to access protected routes.
## Accessing protected routes
There is two ways of passing the token along the request :
- Passing the token in the `authorization` header with the following string format : `Bearer `
- Passing the token as a query parameter : `https://app.dev/protected?token=`
## Implementing client applications
For your client applications, you can use our companion package, [machina client](https://github.com/code16/machina-client).