OAuth2 between Laravel projects
A package that allows secure communication between two or more projects, focused mainly for use in microservices architectures, adding the Oauth2 authorization standard in addition to security at the network level by IP addresses and whitelists, which may already be owned.
Features
- Simple implementation
- It does not increase the latency of requests between microservices.
- High level of security
Prerequisites
-
Having an authorization server, it is recommended to use Laravel Passport for this, specifically in the Client Credentials Grant Tokens section
-
Store the file
oauth-public.keyat folderstorage/app/in the microservices to communicate, this file is provided by the authorization server
Installation
-
Import the library
composer require diimolabs/laravel-oauth2-client -
Add the following environment variables:
OAUTH_HOST= OAUTH_CLIENT_ID= OAUTH_CLIENT_SECRET=And fill with the data provided by the authorization server when creating the client corresponding to the project
-
Implement the
middlewarethat validates the authorization of the input requests, in the fileapp/Http/kernel.phpprotected $routeMiddleware = [ // Other middleware... 'jwt' => \Diimolabs\OAuth\Middleware\EnsureJwtIsValid::class ];
Use
Example of requesting a resource to a microservice
use Diimolabs\OAuth\Facades\OAuthClient;
use Illuminate\Support\Facades\Route;
Route::prefix('v1')->group(function(){
Route::get('message', function(){
return OAuthClient::request()
->get('http://msa-2.test/api/v1/hello-world')
->body();
});
});
Example of a request from a microservice client
use Illuminate\Support\Facades\Route;
Route::prefix('v1')->middleware('jwt')->group(function ()
{
Route::get('/hello-world', function ()
{
return 'Hello world from microservice 2';
});
});
Extra
import the configuration file using:
php artisan vendor:publish --tag=oauth-client
in external_services you can manage the urls of your different services
9 Nov 30, 2022
8 Jul 31, 2022
23 Dec 27, 2022
2.2k Dec 30, 2022
18 Jul 12, 2021
34 Feb 14, 2022
860 Jan 1, 2023
8 Oct 22, 2022
261 Jan 17, 2022
2 Jan 1, 2022
2 Nov 10, 2022
1 Nov 15, 2022
6 Nov 2, 2022
3.1k Dec 31, 2022
0 Dec 24, 2021
253 Dec 21, 2022
1.2k Dec 22, 2022
785 Dec 31, 2022