laravel
10. 软件包
Laravel Socialite

介绍

除了典型的基于表单的认证外，Laravel 还使用 Laravel Socialite (opens in a new tab) 为使用 OAuth 提供程序进行认证提供了一种简单、便捷的方式。Socialite 目前支持通过 Facebook、X、LinkedIn、Google、GitHub、GitLab、Bitbucket 和 Slack 进行认证。

[!NOTE]
其他平台的适配器可通过社区驱动的 Socialite Providers (opens in a new tab) 网站获取。

安装

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

composer require laravel/socialite

升级 Socialite

升级到 Socialite 的新主要版本时，您需要仔细查看 升级指南 (opens in a new tab)。

配置

在使用 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',
],

[!NOTE]
如果 redirect 选项包含相对路径，它将自动解析为完全限定的 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');
});

[!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();

Slack Bot 范围

Slack 的 API 提供了不同类型的访问令牌 (opens in a new tab)，每种令牌都有其自己的一组权限范围 (opens in a new tab)。Socialite 与以下两种 Slack 访问令牌类型兼容：

  • Bot（以 xoxb- 为前缀）
  • User（以 xoxp- 为前缀）

默认情况下，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();

[!WARNING]
使用 with 方法时，请注意不要传递任何保留关键字，如 state 或 response_type 。

获取用户详细信息

在用户被重定向回您应用程序的身份验证回调路由后，您可以使用 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 提供方...
    $token = $user->token;
    $refreshToken = $user->refreshToken;
    $expiresIn = $user->expiresIn;

    // OAuth 1.0 提供方...
    $token = $user->token;
    $tokenSecret = $user->tokenSecret;

    // 所有提供方...
    $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();
Laravel ScoutLaravel Telescope（Laravel 望远镜）