adaojunior/passport-social-grant

Social grant for Laravel Passport

v4.3.1 2024-08-10 00:46 UTC

Requires

• php: ^7.2|^8.0
• laravel/passport: ^8.0|^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• phpunit/phpunit: ^8.5|^9.0

MIT

• Adão Júnior

• oauth
• social
• laravel
• passport
• guard

README

This package adds a social grant to your Oauth2 Server.

Installation

You can install the package via composer:

composer require adaojunior/passport-social-grant

The package will automatically register its service provider. Or you may manually add the service provider in your config/app.php file:

'providers' => [
    // ...
    Adaojunior\PassportSocialGrant\SocialGrantServiceProvider::class,
];

Setup

1. Implement the SocialGrantUserProvider interface:

<?php

namespace App\SocialGrant;

use Laravel\Socialite\Facades\Socialite;
use Illuminate\Contracts\Auth\Authenticatable;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use Adaojunior\PassportSocialGrant\SocialGrantUserProvider;

class UserProvider implements SocialGrantUserProvider
{
    /**
     * Retrieve a user by provider and access token.
     *
     * @param string $provider
     * @param string $accessToken
     * @param ClientEntityInterface $client
     * @return Authenticatable|null
     */
    public function getUserByAccessToken(string $provider, string $accessToken, ClientEntityInterface $client):? Authenticatable
    {

    }
}

1. Bind SocialGrantUserProvider interface to your implementation in the register method of your application service provider app/Providers/AppServiceProvider.php:

$this->app->bind(
    Adaojunior\PassportSocialGrant\SocialGrantUserProvider::class,
    App\SocialGrant\UserProvider::class
);

Usage

$response = $http->post('http://your.app/oauth/token', [
    'form_params' => [
        'grant_type' => 'social',
        'client_id' => $clientId,
        'client_secret' => $clientSecret,
        'provider' => $providerName, // name of provider (e.g., 'facebook', 'google' etc.)
        'access_token' => $providerAccessToken, // access token issued by specified provider
    ],
]);