Laravel 13.x 中文文档

主题

Laravel Socialite ​

简介 ​

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

NOTE

其他平台的适配器可通过社区驱动的 Socialite Providers 网站获取。

安装 ​

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

shell
composer require laravel/socialite

升级 Socialite ​

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

配置 ​

在使用 Socialite 之前，您需要为应用程序使用的 OAuth 提供商添加凭据。通常，这些凭据可以通过在您要进行身份验证的服务的控制面板中创建「开发者应用程序」来获取。

这些凭据应放置在应用程序的 config/services.php 配置文件中，并根据应用程序所需的提供商使用键名 facebook、x、linkedin-openid、google、github、gitlab、bitbucket、slack 或 slack-openid：

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

NOTE

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

身份验证 ​

路由 ​

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

php
use Laravel\Socialite\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 提供商获取用户后，您可以确定用户是否存在于应用程序的数据库中并验证用户。如果用户不存在于应用程序的数据库中，通常会在数据库中创建一个新记录来代表该用户：

php
use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Laravel\Socialite\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 方法指定应包含在身份验证请求中的「范围」。此方法会将之前指定的所有范围与您指定的范围合并：

php
use Laravel\Socialite\Socialite;

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

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

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

Slack Bot 范围 ​

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

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

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

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

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

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

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

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

可选参数 ​

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

php
use Laravel\Socialite\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，此对象上可能有不同的属性和方法：

php
use Laravel\Socialite\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 方法获取他们的用户详细信息：

php
use Laravel\Socialite\Socialite;

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

如果您通过 iOS 应用程序使用 Facebook Limited Login，Facebook 将返回 OIDC 令牌而不是访问令牌。与访问令牌一样，可以将 OIDC 令牌提供给 userFromToken 方法以获取用户详细信息。

无状态身份验证 ​

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

php
use Laravel\Socialite\Socialite;

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

测试 ​

Laravel Socialite 提供了一种便捷的方式来测试 OAuth 身份验证流程，而无需向 OAuth 提供商发出实际请求。fake 方法允许您模拟 OAuth 提供商的行为并定义应返回的用户数据。

模拟重定向 ​

要测试您的应用程序是否正确将用户重定向到 OAuth 提供商，您可以在向重定向路由发出请求之前调用 fake 方法。这将导致 Socialite 返回到虚假授权 URL 的重定向，而不是重定向到实际的 OAuth 提供商：

php
use Laravel\Socialite\Socialite;

test('user is redirected to github', function () {
    Socialite::fake('github');

    $response = $this->get('/auth/github/redirect');

    $response->assertRedirect();
});

模拟回调 ​

要测试应用程序的回调路由，您可以调用 fake 方法并提供当应用程序从提供商请求用户详细信息时应返回的 User 实例。可以使用 map 方法创建 User 实例：

php
use Laravel\Socialite\Socialite;
use Laravel\Socialite\Two\User;

test('user can login with github', function () {
    Socialite::fake('github', (new User)->map([
        'id' => 'github-123',
        'name' => 'Jason Beggs',
        'email' => 'jason@example.com',
    ]));

    $response = $this->get('/auth/github/callback');

    $response->assertRedirect('/dashboard');

    $this->assertDatabaseHas('users', [
        'name' => 'Jason Beggs',
        'email' => 'jason@example.com',
        'github_id' => 'github-123',
    ]);
});

默认情况下，User 实例还将包含一个 token 属性。如果需要，您可以在 User 实例上手动指定其他属性：

php
$fakeUser = (new User)->map([
    'id' => 'github-123',
    'name' => 'Jason Beggs',
    'email' => 'jason@example.com',
])->setToken('fake-token')
  ->setRefreshToken('fake-refresh-token')
  ->setExpiresIn(3600)
  ->setApprovedScopes(['read', 'write'])