Laravel Laravel
  • 前言

    • 发行说明
    • 升级向导
    • 贡献导引
  • 入门指南

    • 安装
    • 配置
    • 文件夹结构
    • 前端
    • 入门套件
    • 部署
  • 架构思想

    • 请求生命周期
    • 服务容器
    • 服务提供者
    • Facades:门面
  • 基础功能

    • 路由
    • 中间件
    • CSRF 保护
    • 控制器
    • 请求
    • 响应
    • 视图
    • Blade 模板
    • Vite编译资产
    • URL 生成
    • Session
    • 表单验证
    • 错误处理
    • 日志
  • 深入话题

    • Artisan 命令行
    • 广播
    • 缓存
    • 集合
    • Contracts:契约
    • 事件
    • 文件存储
    • 辅助函数
    • HTTP 客户端
    • 本地化
    • Mail
    • 消息通知
    • 扩展包开发
    • 队列
    • 速率限制
    • 任务调度
  • 安全

    • 身份认证
    • 授权
    • 邮件验证
    • 加密
    • 哈希
    • 重置密码
  • 数据库

    • 快速入门
    • 查询构造器
    • 分页
    • 数据库迁移
    • 数据填充
    • Redis
  • Eloquent ORM

    • 快速入门
    • 关联关系
    • Eloquent 集合
    • 修改器 & 类型转换
    • API 资源
    • 序列化
  • 测试

    • 快速入门
    • HTTP 测试
    • 命令行测试
    • 浏览器测试
    • 数据库测试
    • 测试模拟器Mocking
  • 官方扩展包

    • Breeze
    • Cashier (Stripe)
    • Cashier (Paddle)
    • Dusk 浏览器测试
    • Envoy 部署工具
    • Fortify 授权生成器
    • Homestead 虚拟机
    • Horizon 队列管理工具
    • Jetstream 全栈开发
    • Mix
    • Octane 加速引擎
    • Passport OAuth 认证
    • Sail 开发环境
    • Sanctum 轻量级 API 认证
    • Scout 全文搜索
    • Socialite 社会化登录
    • Telescope 调试工具
    • Valet 集成环境
  • API 文档
0 0

Socialite 社会化登录
9.x
9.x 8.5 8.x 7.x 6.x 5.8 5.7 5.6 5.5 5.4 5.3 5.2 5.1

Laravel 9 中文文档 /

未匹配的标注

Laravel Socialite

  • 简介
  • 安装
  • 升级社会化登录
  • 配置
  • 认证
    • 路由
    • 身份验证和存储
    • 访问范围
    • 可选参数
  • 检索用户详细信息

简介

除了典型的基于表单的身份验证之外,Laravel 还提供了一种使用 Laravel Socialite对 OAuth providers 进行身份验证的简单方便的方法。 Socialite 目前支持 Facebook,Twitter,LinkedIn,Google,GitHub,GitLab 和 Bitbucket 的身份验证。

技巧:其他平台的驱动器可以在 Socialite Providers 社区驱动网站查找。

安装

在开始使用 Socialite 之前,通过 Composer 软件包管理器将软件包添加到项目的依赖项中:

composer require laravel/socialite

升级社会化登录

升级到 Socialite 的新主要版本时,请务必仔细查看 the upgrade guide.

配置

在使用 Socialite 之前,您还需要为应用程序使用的 OAuth 服务添加凭据。这些凭证应该放在你的 config/services.php 配置文件中, 并且应该使用 facebook, twitter,linkedin, google, github, gitlab, 或 bitbucket作为键名,取决于您的应用程序所需的提供商。例如:

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

技巧:如果 redirect 项的值包含一个相对路径,它将会自动解析为全称 URL。

认证

路由

要使用 OAuth 提供程序对用户进行身份验证,你需要两个路由:一个用于将用户重定向到 OAuth provider,另一个用于在身份验证后接收来自 provider 的回调。下面的示例控制器演示了这两个路由的实现:

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 provider,而该 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::where('github_id', $githubUser->id)->first();

    if ($user) {
        $user->update([
            'github_token' => $githubUser->token,
            'github_refresh_token' => $githubUser->refreshToken,
        ]);
    } else {
        $user = User::create([
            'name' => $githubUser->name,
            'email' => $githubUser->email,
            'github_id' => $githubUser->id,
            'github_token' => $githubUser->token,
            'github_refresh_token' => $githubUser->refreshToken,
        ]);
    }

    Auth::login($user);

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

技巧:有关特定 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 providers 支持重定向请求中的可选参数。 要在请求中包含任何可选参数,请使用关联数组调用 with 方法:

use Laravel\Socialite\Facades\Socialite;

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

注意:使用 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 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 方法可用于禁用会话状态验证。 这在向 API 添加社交身份验证时非常有用:

use Laravel\Socialite\Facades\Socialite;

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

注意:Twitter 驱动程序不支持无状态身份验证,它使用 OAuth 1.0 进行身份验证

本文章首发在 网站上。



原文地址:cndocs/9.x/soc...

译文地址:cndocs/9.x/soc...

上一篇 下一篇

成为Laravel合作伙伴

Laravel Partners是提供一流Laravel开发和咨询服务的精英商店。我们每个合作伙伴都可以帮助您制定一个精美,结构完善的项目.

我们的伙伴
Laravel
亮点
  • Our Team
  • Release Notes
  • Getting Started
  • Routing
  • Blade Templates
  • Authentication
  • Authorization
  • Artisan Console
  • Database
  • Eloquent ORM
  • Testing
资源
  • Laracasts
  • Laravel News
  • Laracon
  • Laracon EU
  • Jobs
  • Certification
  • Forums
  • 版本发布时间
  • 包开发
  • 命令行应用
  • TALL stack全栈开发
  • Blade UI Kit
  • 前端资源构建
伙伴
  • Vehikl
  • Tighten Co.
  • Kirschbaum
  • Byte 5
  • 64 Robots
  • Cubet
  • DevSquad
  • Ideil
  • Cyber-Duck
  • ABOUT YOU
  • A2 Design
  • Romega Software
  • Jump24
  • Become A Partner
生态系统
  • Cashier
  • Dusk
  • Echo
  • Envoyer
  • Forge
  • Homestead
  • Horizon
  • Lumen
  • Mix
  • Nova
  • Passport
  • Scout
  • Socialite
  • Spark
  • Telescope
  • Valet
  • Vapor

Laravel是一个具有表达力,优雅语法的Web应用程序框架。我们认为,发展必须是一种令人愉悦的创造力,才能真正实现。Laravel试图通过减轻大多数Web项目中使用的常见任务来减轻开发的痛苦.

Laravel是Taylor Otwell的商标.
Copyright © 2011-2022 Laravel中文网 LLC.

  • Twitter
  • GitHub
  • Discord
Laravel PHP中文网 推荐使用阿里云