除了典型的基于表单的认证方式之外,Laravel 还提供一种简单、便捷的方式,使用 Laravel Socialite 通过 OAuth 提供商进行认证。Socialite 目前支持通过 Facebook、X、领英、谷歌、GitHub、GitLab、Bitbucket 和 Slack 进行认证。
[!NOTE]
适用于其他平台的适配器可通过社区驱动的 Socialite Providers 网站获取。
要开始使用 Socialite,请使用 Composer 包管理器将该包添加到你的项目依赖中:
composer require laravel/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',
],[!注意]
如果redirect选项包含相对路径,它将自动解析为一个完全限定的 URL。
要使用OAuth提供商进行用户身份验证,您将需要两个路由:一个用于将用户重定向到OAuth提供商,另一个用于在身份验证后接收来自提供商的回调。下面的示例路由演示了这两个路由的实现:
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 facade 提供的 redirect 方法负责将用户重定向到 OAuth 提供商,而 user 方法则会检查传入的请求,并在用户批准身份验证请求后,从提供商那里检索用户的信息。
一旦用户从 OAuth 提供商中检索到,您就可以确定用户是否存在于您的应用程序数据库中并验证该用户。如果用户不存在于您的应用程序数据库中,您通常会在数据库中创建一个新记录来表示该用户:
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 方法来指定应包含在认证请求中的“作用域”。此方法将把所有先前指定的作用域与您指定的作用域合并:
use Laravel\Socialite\Socialite;
return Socialite::driver('github')
->scopes(['read:user', 'public_repo'])
->redirect();您可以使用 setScopes 方法覆盖认证请求上的所有现有作用域:
return Socialite::driver('github')
->setScopes(['read:user', 'public_repo'])
->redirect();Slack 的 API 提供了 不同类型的访问令牌,每种都具有各自的 权限范围。Socialite 兼容以下两种 Slack 访问令牌类型:
默认情况下,该 slack 驱动程序将生成一个 user 令牌并且调用该驱动程序的 user 方法将返回用户的详细信息。
Bot 令牌主要用于您的应用程序向您的应用程序用户拥有的外部 Slack 工作区发送通知的情况。要生成 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();生成机器人令牌时,user 方法仍将返回一个 Laravel\Socialite\Two\User 实例;但是,只有 token 属性会被填充。此令牌可以存储,以便 向已认证用户的 Slack 工作区发送通知。
许多 OAuth 提供商支持重定向请求上的其他可选参数。要在请求中包含任何可选参数,请使用关联数组调用 with 方法:
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:
use Laravel\Socialite\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\Socialite;
$user = Socialite::driver('github')->userFromToken($token);如果您正在通过 iOS 应用程序使用 Facebook 受限登录,Facebook 将返回一个 OIDC 令牌,而不是访问令牌。与访问令牌一样,该 OIDC 令牌可以提供给 userFromToken 方法以便检索用户详细信息。
该 stateless 方法可用于禁用会话状态验证。这在将社交认证添加到不使用基于 Cookie 的会话的无状态 API 时非常有用:
use Laravel\Socialite\Socialite;
return Socialite::driver('google')->stateless()->user();