Laravel Socialite

• 介绍
• 安装
• 升级 Socialite
• 配置
• 身份验证
  • 路由
  • 身份验证和存储
  • 访问范围
  • Slack Bot 范围
  • 可选参数
• 检索用户详细信息

介绍

除了典型基于表单的身份验证外，Laravel 还提供了一种简单方便的方法，可以使用 Laravel Socialite 通过 OAuth 提供商进行身份验证。Socialite 目前支持通过 Facebook、X、LinkedIn、Google、GitHub、GitLab、Bitbucket 和 Slack 进行身份验证。

安装

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

composer require laravel/socialite

升级 Socialite

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

配置

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

这些凭据应放置在应用程序的 config/services.php 配置文件中，并应使用密钥 facebook、x、linkedin-openid、google、github、gitlab、bitbucket、slack 或 slack-openid，具体取决于应用程序所需的提供商

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

身份验证

路由

要使用 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
});

Socialite 门面提供的 redirect 方法负责将用户重定向到 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');
});

访问范围

在重定向用户之前，您可以使用 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();

Slack Bot 范围

Slack 的 API 提供了 不同类型的访问令牌，每个令牌都有自己的一组 权限范围。Socialite 与以下两种 Slack 访问令牌类型兼容

默认情况下，slack 驱动程序将生成一个 user 令牌，并且调用驱动程序的 user 方法将返回用户的详细信息。

如果您的应用程序将向由应用程序用户拥有的外部 Slack 工作区发送通知，则 Bot 令牌非常有用。要生成 Bot 令牌，请在将用户重定向到 Slack 进行身份验证之前调用 asBotUser 方法

return Socialite::driver('slack')
    ->asBotUser()
    ->setScopes(['chat:write', 'chat:write.public', 'chat:write.customize'])
    ->redirect();

此外，在 Slack 将用户重定向回您的应用程序进行身份验证后，在调用 user 方法之前，您必须调用 asBotUser 方法

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

生成 Bot 令牌时，user 方法仍将返回 Laravel\Socialite\Two\User 实例；但是，只有 token 属性会被填充。可以存储此令牌以 向已认证用户的 Slack 工作区发送通知。

可选参数

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

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

检索用户详细信息

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

根据您正在进行身份验证的 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();
});

从令牌检索用户详细信息

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

use Laravel\Socialite\Facades\Socialite;
 
$user = Socialite::driver('github')->userFromToken($token);

如果您正在通过 iOS 应用程序使用 Facebook 受限登录，Facebook 将返回 OIDC 令牌而不是访问令牌。与访问令牌类似，可以将 OIDC 令牌提供给 userFromToken 方法以检索用户详细信息。

无状态身份验证

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

use Laravel\Socialite\Facades\Socialite;
 
return Socialite::driver('google')->stateless()->user();