Laravel 7.x Laravel Socialite

イントロダクション

典型的なフォームベースの認証に付け加え、LaravelはLaravel Socialite(=名士)による、OAuthプロバイダによるシンプルで便利な認証方法も提供しています。Socialiteは現在、Facebook、Twitter、LinkedIn、Google、GitHub、GitLab、Bitbucketによる認証をサポートしています。

Tip!! 他のプラットフォームのアダプタは、コミュニティにより管理されているSocialiteプロバイダWebサイトで一覧できます。

Socialiteのアップデート

Socialiteのメジャーバージョンへアップデートするときは、アップグレードガイドを十分にレビューしてください。

インストール

Socialiteを使用開始するには、Composerを使い、プロジェクトの依存パッケージに追加してください。

composer require laravel/socialite

設定

Socialiteを使用する前に、アプリケーションで使用するOAuthサービスの認証情報も追加する必要があります。認証情報はconfig/services.php設定ファイルで指定し、アプリケーションの必要に合わせ、facebook、twitter、linkedin、google、github、gitlab、bitbucketキーを使用してください。一例をご覧ください。

'github' => [
    'client_id' => env('GITHUB_CLIENT_ID'),
    'client_secret' => env('GITHUB_CLIENT_SECRET'),
    'redirect' => 'http://your-callback-url',
],

Tip!! redirectオプションが相対パスである場合、自動的に完全なURLへ解決されます。

ルート

これで、ユーザーを認証する準備ができました。２つのルートが必要になります。ひとつはOAuthプロバイダへユーザーをリダイレクトするルート、もう一つは認証後にプロバイダーからのコールバックを受けるルートです。Socialiteファサードを使用し、Socialiteにアクセスしましょう。

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;
use Laravel\Socialite\Facades\Socialite;

class LoginController extends Controller
{
    /**
     * GitHubの認証ページヘユーザーをリダイレクト
     *
     * @return \Illuminate\Http\Response
     */
    public function redirectToProvider()
    {
        return Socialite::driver('github')->redirect();
    }

    /**
     * GitHubからユーザー情報を取得
     *
     * @return \Illuminate\Http\Response
     */
    public function handleProviderCallback()
    {
        $user = Socialite::driver('github')->user();

        // $user->token;
    }
}

redirectメソッドはユーザーをOAuthプロバイダへ送るのを担当します。一方のuserメソッドは送られて来たリクエストを読み、プロバイダからユーザーの情報を取得します。

コントローラメソッドへのルートを定義する必要があります。

Route::get('login/github', 'Auth\LoginController@redirectToProvider');
Route::get('login/github/callback', 'Auth\LoginController@handleProviderCallback');

オプションのパラメータ

多くのOAuthプロバイダがリダイレクトリクエスト中のオプションパラメータをサポートしています。リクエストにオプションパラメータを含めるには、withメソッドを呼び出し、連想配列を渡します。

return Socialite::driver('google')
    ->with(['hd' => 'example.com'])
    ->redirect();

Note: withメソッドを使用時は、stateやresponse_typeなどの予約キーワードを渡さないように注意してください。

アクセススコープ

ユーザーをリダイレクトする前に、scopesメソッドを使用し、リクエストへ「スコープ」を追加することもできます。このメソッドは、存在する全スコープを皆さんが指定したものへマージします。

return Socialite::driver('github')
    ->scopes(['read:user', 'public_repo'])
    ->redirect();

setScopesメソッドを使用し、存在するスコープをすべてオーバーライトできます。

return Socialite::driver('github')
    ->setScopes(['read:user', 'public_repo'])
    ->redirect();

ステートレスな認証

statelessメソッドは、セッション状態の確認を無効化するために使用します。これはAPIへソーシャル認証を追加する場合に便利です。

return Socialite::driver('google')->stateless()->user();

Note: ステートレスな認証は、認証にOAuth1.0を使用しているTwitterドライバでは利用できません。

ユーザー詳細情報の取得

ユーザーインスタンスを取得したら、詳細情報をもっと取得できます。

$user = Socialite::driver('github')->user();

// OAuth Twoプロバイダ
$token = $user->token;
$refreshToken = $user->refreshToken; // 常に提供されているとは限らない
$expiresIn = $user->expiresIn;

// OAuth Oneプロバイダ
$token = $user->token;
$tokenSecret = $user->tokenSecret;

// 全プロバイダ
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();

トークンからのユーザー詳細情報の取得(OAuth2)

ユーザーへの有効なアクセストークンを事前に取得している場合は、userFromTokenメソッドを用い、詳細を取得できます。

$user = Socialite::driver('github')->userFromToken($token);

トークンとSecretからのユーザー詳細情報の取得(OAuth1)

すでにユーザーに対する有効なトークン／secretペアを取得している場合は、userFromTokenAndSecretメソッドを用い、詳細を取得できます。

$user = Socialite::driver('twitter')->userFromTokenAndSecret($token, $secret);