Laravel 社交名媛

• Introduction
• Installation
• 升级社交名媛
• Configuration
• Authentication
  • Routing
  • 身份验证和存储
  • 访问范围
  • 可选参数
• 检索用户详细信息

#Introduction

除了典型的基于表单的身份验证之外，Laravel 还提供了一种简单方便的方式来使用 OAuth 提供者进行身份验证Laravel 社交名媛. Socialite 目前支持通过 Facebook、Twitter、LinkedIn、Google、GitHub、GitLab 和 Bitbucket 进行身份验证。

Note
其他平台的适配器可通过社区驱动获得名媛提供者 网站。

#Installation

要开始使用 Socialite，请使用 Composer 包管理器将包添加到项目的依赖项中：

composer require laravel/socialite

#升级社交名媛

升级到 Socialite 的新主要版本时，请务必仔细查看升级指南.

#Configuration

在使用 Socialite 之前，您需要为您的应用程序使用的 OAuth 提供商添加凭据。通常，可以通过在您将要进行身份验证的服务的仪表板中创建“开发人员应用程序”来检索这些凭据。

这些凭据应放在您的应用程序的config/services.php 配置文件，并且应该使用密钥facebook,twitter (OAuth 1.0),twitter-oauth-2 (OAuth 2.0),linkedin,google,github,gitlab， 或者bitbucket，取决于您的应用程序需要的提供商：

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

Note
如果redirect 选项包含相对路径，它将自动解析为完全限定的 URL。

#Authentication

#Routing

要使用 OAuth 提供者对用户进行身份验证，您将需要两个路由：一个用于将用户重定向到 OAuth 提供者，另一个用于在身份验证后接收来自提供者的回调。下面的示例路由演示了这两条路由的实现：

use Laravel\Socialite\Facades\Socialite;

Route::get('/auth/redirect', function () {
    return Socialite::driver('github')->redirect();
});

Route::get('/auth/callback', function () {
    $user = Socialite::driver('github')->user();

    // $user->token
});

这redirect 提供的方法Socialite facade 负责将用户重定向到 OAuth 提供者，而user 方法将检查传入的请求，并在用户批准身份验证请求后从提供者处检索用户信息。

#身份验证和存储

从 OAuth 提供程序检索到用户后，您可以确定该用户是否存在于您的应用程序的数据库中，并且验证用户.如果应用程序的数据库中不存在该用户，您通常会在数据库中创建一条新记录来代表该用户：

use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Laravel\Socialite\Facades\Socialite;

Route::get('/auth/callback', function () {
    $githubUser = Socialite::driver('github')->user();

    $user = User::updateOrCreate([
        'github_id' => $githubUser->id,
    ], [
        'name' => $githubUser->name,
        'email' => $githubUser->email,
        'github_token' => $githubUser->token,
        'github_refresh_token' => $githubUser->refreshToken,
    ]);

    Auth::login($user);

    return redirect('/dashboard');
});

Note
有关特定 OAuth 提供程序提供哪些用户信息的更多信息，请参阅文档检索用户详细信息.

#访问范围

在重定向用户之前，您可以使用scopes 方法来指定应包含在身份验证请求中的“范围”。此方法会将所有先前指定的范围与您指定的范围合并：

use Laravel\Socialite\Facades\Socialite;

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

您可以使用以下方法覆盖身份验证请求中的所有现有范围setScopes 方法：

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

#可选参数

许多 OAuth 提供程序支持重定向请求中的其他可选参数。要在请求中包含任何可选参数，请调用with 关联数组的方法：

use Laravel\Socialite\Facades\Socialite;

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

Warning
当使用with 方法，注意不要传递任何保留关键字，例如state 或者response_type.

#检索用户详细信息

在用户被重定向回您的应用程序的身份验证回调路由后，您可以使用 Socialite 的user 方法。返回的用户对象user method 提供了多种属性和方法，您可以使用这些属性和方法将有关用户的信息存储在您自己的数据库中。

根据您进行身份验证的 OAuth 提供程序是否支持 OAuth 1.0 或 OAuth 2.0，此对象可能有不同的属性和方法：

use Laravel\Socialite\Facades\Socialite;

Route::get('/auth/callback', function () {
    $user = Socialite::driver('github')->user();

    // OAuth 2.0 providers...
    $token = $user->token;
    $refreshToken = $user->refreshToken;
    $expiresIn = $user->expiresIn;

    // OAuth 1.0 providers...
    $token = $user->token;
    $tokenSecret = $user->tokenSecret;

    // All providers...
    $user->getId();
    $user->getNickname();
    $user->getName();
    $user->getEmail();
    $user->getAvatar();
});

从令牌中检索用户详细信息 (OAuth2)

如果您已经拥有用户的有效访问令牌，则可以使用 Socialite 检索他们的用户详细信息userFromToken 方法：

use Laravel\Socialite\Facades\Socialite;

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

从令牌和秘密中检索用户详细信息 (OAuth1)

如果您已经拥有用户的有效令牌和密码，则可以使用 Socialite 的检索他们的用户详细信息userFromTokenAndSecret 方法：

use Laravel\Socialite\Facades\Socialite;

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

无状态认证

这stateless 方法可用于禁用会话状态验证。这在将社交身份验证添加到不使用基于 cookie 的会话的无状态 API 时非常有用：

use Laravel\Socialite\Facades\Socialite;

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

Warning
无状态身份验证不适用于 Twitter OAuth 1.0 驱动程序。