coderello / laravel-passport-social-grant
Social Grant for Laravel Passport
Installs: 452 246
Dependents: 4
Suggesters: 0
Security: 0
Stars: 174
Watchers: 5
Forks: 20
Open Issues: 1
Requires
- php: ^8.2
- laravel/passport: ^11.3.0 || ^12.0
Requires (Dev)
- laminas/laminas-diactoros: ^2.8
- mockery/mockery: ^1.4.4
- orchestra/testbench: ^8.0 || ^9.0
- phpunit/phpunit: ^9.5 || ^10.0
README
This package adds a social grant for your OAuth2 server. It can be useful if have an API and want to provide the ability for your users to login/register through social networks.
As a result you will be able to exchange access_token
, issued by the OAuth2 server of any social provider,
to access_token
and refresh_token
issued by your own OAuth2 server.
You will receive this access_token
and return the user instance that corresponds to it on your own.
Installation
You can install this package via composer using this command:
composer require coderello/laravel-passport-social-grant
The package will automatically register itself.
Configuring
As the first step, you need to implement SocialUserResolverInterface
:
Here is an example using Socialite -
<?php namespace App\Resolvers; use Coderello\SocialGrant\Resolvers\SocialUserResolverInterface; use Illuminate\Contracts\Auth\Authenticatable; use Laravel\Socialite\Facades\Socialite; use Laravel\Socialite\Two\User as ProviderUser; class SocialUserResolver implements SocialUserResolverInterface { /** * Resolve user by provider credentials. */ public function resolveUserByProviderCredentials(string $provider, string $accessToken): ?Authenticatable { // Return the user that corresponds to provided credentials. // If the credentials are invalid, then return NULL. $providerUser = Socialite::driver($provider)->userFromToken($accessToken); return $this->findOrCreateUser($provider, $providerUser);; } protected function findOrCreateUser(string $provider, ProviderUser $providerUser): ?Authenticatable { // todo your logic here // $email = $providerUser->getEmail(); } }
The next step is to bind SocialUserResolverInterface
to your implementation.
You can do it by adding the appropriate key-value pair to $bindings
property in AppServiceProvider
:
<?php namespace App\Providers; use App\Resolvers\SocialUserResolver; use Coderello\SocialGrant\Resolvers\SocialUserResolverInterface; use Illuminate\Support\ServiceProvider; class AppServiceProvider extends ServiceProvider { /** * All the container bindings that should be registered. */ public $bindings = [ SocialUserResolverInterface::class => SocialUserResolver::class, ]; }
You are done!
Usage
Example of usage with axios
:
axios.post('/oauth/token', { grant_type: 'social', // static 'social' value client_id: clientId, // client id client_secret: clientSecret, // client secret provider: providerName, // name of provider (e.g., 'facebook', 'google' etc.) access_token: providerAccessToken, // access token issued by specified provider }) .then((response) => { const { access_token: accessToken, expires_in: expiresIn, refresh_token: refreshToken, } = response.data; // success logic }) .catch((error) => { const { message, hint, } = error.response.data; // error logic });
Example of usage with guzzlehttp/guzzle
:
<?php use GuzzleHttp\Client; use Illuminate\Support\Arr; $http = new Client; $response = $http->post($domain . '/oauth/token', [ RequestOptions::FORM_PARAMS => [ 'grant_type' => 'social', // static 'social' value 'client_id' => $clientId, // client id 'client_secret' => $clientSecret, // client secret 'provider' => $providerName, // name of provider (e.g., 'facebook', 'google' etc.) 'access_token' => $providerAccessToken, // access token issued by specified provider ], RequestOptions::HTTP_ERRORS => false, ]); $data = json_decode($response->getBody()->getContents(), true); if ($response->getStatusCode() === Response::HTTP_OK) { $accessToken = Arr::get($data, 'access_token'); $expiresIn = Arr::get($data, 'expires_in'); $refreshToken = Arr::get($data, 'refresh_token'); // success logic } else { $message = Arr::get($data, 'message'); $hint = Arr::get($data, 'hint'); // error logic }
Testing
You can run the tests with:
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
Created by Illia Sakovich
Maintained by Ankur Kumar
License
The MIT License (MIT). Please see License File for more information.