Download the PHP package claudiorodrigo/passport-multiauth without Composer
On this page you can find all versions of the php package claudiorodrigo/passport-multiauth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download claudiorodrigo/passport-multiauth
More information about claudiorodrigo/passport-multiauth
Files in claudiorodrigo/passport-multiauth
Package passport-multiauth
Short Description Add support to multi-auth on Laravel Passport
License MIT
Informations about the package passport-multiauth
Laravel Passport Multi-Auth
Add multi-authentication support to Laravel Passport
Upgrading from 4.0 to 5.0
- To upgrade from version 4.0 to 5.0 folow this guide
Upgrading from 2.0 to 3.0
- To upgrade from version 2.0 to 3.0 folow this guide
Upgrading from 1.0 to 2.0
- To upgrade from version 1.0 to 2.0 follow this guide
Compatibility
Laravel Passport |
---|
^5.0 |
^6.0 |
^7.0 |
^8.0 |
Laravel Framework | Passport Multiauth |
---|---|
<= 5.6 | <= 3.0 |
5.7.x | 4.0.x |
>= 5.7.x <= 5.8.x | 5.0.x |
>= 6.x | 6.x |
Installing and configuring
Install using composer:
To all works fine, we need to ensure that the SMartins\PassportMultiauth\Providers\MultiauthServiceProvider::class
service provider
be registered before Laravel\Passport\PassportServiceProvider::class
.
Firstly, you will remove the laravel/passport
package from Laravel Package Discovery.
In your composer.json
file, add the laravel/passport
to extra.laravel.dont-discover
array:
And register the providers manually on config/app.php
:
WARNING: The provider SMartins\PassportMultiauth\Providers\MultiauthServiceProvider::class
MUST be added before Laravel\Passport\PassportServiceProvider::class
to it works fine.
Maybe you will need clear the bootstrap cache files to re-register the providers:
Migrate database to create oauth_access_token_providers
table:
NOTE If you don't ron the command to install passport run:
Instead of using the Laravel\Passport\HasApiTokens
trait from Laravel Passport core, use the trait SMartins\PassportMultiauth\HasMultiAuthApiTokens
.
Internally, this HasMultiAuthApiTokens
uses the HasApiTokens
, overriding the methods tokens()
and createToken($name, $scopes = [])
.
The behavior of the method tokens()
was changed to join with the table oauth_access_token_providers
getting just the tokens created
to specific model.
The method createToken($name, $scopes = [])
was changed to create the token using the provider
defined to model on config/auth.php
.
Now when you create the token, this token will be related with the model that is calling.
Add new provider in config/auth.php
using a model that extends of Authenticatable
class and use HasMultiAuthApiTokens
trait.
Example:
Configure your model:
And your config/auth.php
providers:
Add a new guard
in config/auth.php
guards array using driver passport
and the provider added above:
Register the middleware AddCustomProvider
to $routeMiddleware
attributes on app/Http/Kernel.php
file.
OBS: The param provider
is required to routes wrapped by AddCustomProvider
middleware.
You must to pass a valid provider configured on config/auth.php
.
Add new middleware Authenticate
on app/Http/Kernel
$routeMiddleware
attribute.
Encapsulate the passport routes for access token with the registered middleware in AuthServiceProvider
.
This middleware will add the capability to Passport
route oauth/token
use the value of provider
param on request:
Optional: Publish migrations:
Just run the vendor:publish
artisan command with package provider as parameter:
If you are not going to use PassportMultiauth's default migrations, you should call the SMartins\PassportMultiauth\PassportMultiauth::ignoreMigrations
method in the register method of your AppServiceProvider.
Usage
Add the provider
parameter in your request at /oauth/token
:
You can pass your guards on multiauth
middleware as you wish. Example:
The api
guard use is equals the example with admin
.
You can pass many guards to multiauth
middleware.
You can use too the Auth
facade:
Refreshing tokens
Add the provider
parameter in your request at /oauth/token
:
Using scopes
Just use the scope
and scopes
middlewares from Laravel\Passport
.
Personal Access Tokens
In your model that uses the trait SMartins\PassportMultiauth\HasMultiAuthApiTokens
you can uses the methods createToken($name, $scopes = [])
and tokens()
to manage your personal access tokens. E.g.:
Known Issues
To all works correctly you must use the default guard web
on config/auth.php
. E.g.:
Exists an opened issues that will be analysed ASAP.
Unit tests
Instead to use the Laravel\Passport\Passport::actingAs()
method, use SMartins\PassportMultiauth\PassportMultiauth::actingAs()
.
The difference is that the actingAs
from this package get the guard based on Authenticatable
instance passed on first parameter and authenticate this user using your guard. On authenticated request (Using auth
middleware from package - SMartins\PassportMultiauth\Http\Middleware\MultiAuthenticate)
the guard is checked on Request
to return the user or throws a Unauthenticated
exception. E.g.:
Sample Project
You can see a complete Passport-Multiauth
implementation using Password Grant Tokens
and Personal Access Token
on passport-multiauth-demo project
Contributors
Based on renanwilian responses to Passport Multi-Auth issue.