README

Socialite 是一个 OAuth2 认证工具。它受到 laravel/socialite 的启发，您可以在任何 PHP 项目中轻松使用它。

要求

PHP >= 7.4

安装

$ composer require "overtrue/socialite" -vvv

使用

对于 Laravel 5: overtrue/laravel-socialite

authorize.php:

<?php

use Overtrue\Socialite\SocialiteManager;

$config = [
    'github' => [
        'client_id'     => 'your-app-id',
        'client_secret' => 'your-app-secret',
        'redirect'      => 'https:///socialite/callback.php',
    ],
];

$socialite = new SocialiteManager($config);

$url = $socialite->create('github')->redirect();

return redirect($url); 

callback.php:

<?php

use Overtrue\Socialite\SocialiteManager;

$config = [
    'github' => [
        'client_id' => 'your-app-id',
        'client_secret' => 'your-app-secret',
        'redirect' => 'https:///socialite/callback.php',
    ],
];

$socialite = new SocialiteManager($config);

$code = request()->query('code');

$user = $socialite->create('github')->userFromCode($code);

$user->getId();        // 1472352
$user->getNickname();  // "overtrue"
$user->getUsername();  // "overtrue"
$user->getName();      // "安正超"
$user->getEmail();     // "anzhengchao@gmail.com"
...

配置

现在我们支持以下网站

Alipay，Dingtalk，facebook，github，google，linkedin，outlook，weibo，taobao，qq，wechat，douyin，baidu，feishu 和 douban。

每个创建都使用相同的配置键：client_id，client_secret，redirect。

示例

...
  'weibo' => [
    'client_id'     => 'your-app-id',
    'client_secret' => 'your-app-secret',
    'redirect'      => 'https:///socialite/callback.php',
  ],
...

自定义应用名称

您可以使用任何喜欢的名称作为应用程序的名称，例如 foo，并使用 provider 键设置提供者：

$config = [
    'foo' => [
        'provider' => 'github',  // <-- 
        'client_id' => 'your-app-id',
        'client_secret' => 'your-app-secret',
        'redirect' => 'https:///socialite/callback.php',
    ],
       
    // another github app
    'bar' => [
        'provider' => 'github',  // <-- 
        'client_id' => 'your-app-id',
        'client_secret' => 'your-app-secret',
        'redirect' => 'https:///socialite/callback.php',
    ],
    //...
];

扩展自定义提供者

您可以从自定义提供者轻松创建应用程序，您有两种方法来做这件事：

1. 使用自定义创建器

$config = [
    'foo' => [
        'provider' => 'myprovider',  // <-- 
        'client_id' => 'your-app-id',
        'client_secret' => 'your-app-secret',
        'redirect' => 'https:///socialite/callback.php',
    ],
];

$socialite = new SocialiteManager($config);
   
$socialite->extend('myprovider', function(array $config) {
    return new MyCustomProvider($config);
});

$app = $socialite->create('foo');

1. 使用提供者

👋🏻 您的自定义提供者类必须实现 Overtrue\Socialite\Contracts\ProviderInterface。

class MyCustomProvider implements \Overtrue\Socialite\Contracts\ProviderInterface 
{
    //...
}

然后使用类名设置 provider

$config = [
    'foo' => [
        'provider' => MyCustomProvider::class,  // <-- class name
        'client_id' => 'your-app-id',
        'client_secret' => 'your-app-secret',
        'redirect' => 'https:///socialite/callback.php',
    ],
];

$socialite = new SocialiteManager($config);
$app = $socialite->create('foo');

支付宝

如果您想使用 alipay 创建，您需要设置如下配置。

...
  'alipay' => [
    // the key, pointed by the key value of this array, can also be named as 'app_id' like the official documentation.
    'client_id' => 'your-app-id', 
 
    // Please refer to the official documentation, in the official management background configuration RSA2.
    // Note: This is your own private key.
    // Note: Do not allow the private key content to have extra characters.
    // Recommendation: For security, you can read directly from the file. But here as long as the value, please remember to remove the head and tail of the decoration.
    'rsa_private_key' => 'your-rsa-private-key',

    // Be sure to set this value and make sure that it is the same address value as set in the official admin system.
    // the key, pointed by the key value of this array, can also be named as 'redirect_url' like the official documentation.
    'redirect' => 'https:///socialite/callback.php',
  ],
...

仅支持 RSA2 个人私钥，因此如果您想使用证书登录，请保持关注。

钉钉

遵循文档，并在开发面板中进行配置。

注意：我们只支持二维码访问第三方网站。即交换用户信息（openid，unionid 和昵称）

...
'dingtalk' => [
    // or 'app_id'
    'client_id' => 'your app id',

    // or 'app_secret' 
    'client_secret' => 'your app secret',

    // or 'redirect_url'
    'redirect' => 'redirect URL'
],
...

抖音

注意：使用抖音创建时，如果您直接使用访问令牌获取用户信息，请首先设置 openid。openid 可以在获取访问令牌时通过 code 获取，因此自动为您配置了 openid 的 userFromCode()，如果首先调用 userFromToken()，则调用 withOpenId()

$user = $socialite->create('douyin')->userFromCode('here is auth code');

$user = $socialite->create('douyin')->withOpenId('openId')->userFromToken('here is a access token');

百度

您可以使用 withDisplay() 选择您想要显示的表单。

create$authUrl = $socialite->driver('baidu')->withDisplay('mobile')->redirect();

popup 模式是默认的显示设置。 basic 是默认的带有作用域的设置。

淘宝

您可以使用 withView() 选择您想要显示的表单。

$authUrl = $socialite->create('taobao')->withView('wap')->redirect();

web 模式是默认的显示设置。 user_info 是默认的带有作用域的设置。

微信

我们支持开放平台第三方平台网页授权代表公众号。

您只需输入如下配置即可。公众号授权不需要。

...
[
    'wechat' =>
        [
            'client_id' => 'client_id',
            'client_secret' => 'client_secret',
            'redirect' => 'redirect-url',

            // Open Platform - Third-party Platform Need
            'component' => [
                // or 'app_id', 'component_app_id' as key
                'id' => 'component-app-id',
                // or 'app_token', 'access_token', 'component_access_token' as key
                'token' => 'component-access-token',
            ]
        ]
],
...

作用域

在重定向用户之前，您还可以使用范围方法在请求上设置 "scopes"。此方法将覆盖所有现有作用域

$response = $socialite->create('github')
                ->scopes(['scope1', 'scope2'])->redirect();

重定向 URL

您还可以动态设置 redirect_uri，您可以使用以下方法更改 redirect_uri URL

$url = 'your callback url.';

$socialite->redirect($url);
// or
$socialite->withRedirectUrl($url)->redirect();

状态

您的应用程序可以使用状态参数来确保响应属于由同一用户发起的请求，从而防止跨站请求伪造 (CSRF) 攻击。CSRF 攻击发生在恶意攻击者欺骗用户执行未经授权执行的操作，而这些操作只有用户有权在受信任的 Web 应用程序上执行，而所有操作都不会涉及或提醒用户。

以下是如何通过提供状态来使您的应用更加安全的最简单示例。在这个示例中，我们使用会话ID作为状态参数，但您可以使用任何您想要的逻辑来为状态创建值。

带有 state 参数的重定向

<?php
session_start();
 
$config = [
    //...
];

// Assign to state the hashing of the session ID
$state = hash('sha256', session_id());

$socialite = new SocialiteManager($config);

$url = $socialite->create('github')->withState($state)->redirect();

return redirect($url); 

验证回调 state

一旦用户授权了您的应用，用户将被重定向回您应用的 redirect_uri。OAuth 服务器将返回不变的状态参数。检查 redirect_uri 中提供的状态是否与您的应用生成的一致

<?php
session_start();
 
$state = request()->query('state');
$code = request()->query('code');
 
// Check the state received with current session id
if ($state != hash('sha256', session_id())) {
    exit('State does not match!');
}
$user = $socialite->create('github')->userFromCode($code);

// authorized

了解更多关于 state 参数的信息

其他参数

要包含任何可选参数，请使用关联数组调用 with 方法

$response = $socialite->create('google')
                    ->with(['hd' => 'example.com'])->redirect();

用户界面

标准用户API

$user = $socialite->create('github')->userFromCode($code);

{
  "id": 1472352,
  "nickname": "overtrue",
  "name": "安正超",
  "email": "anzhengchao@gmail.com",
  "avatar": "https://avatars.githubusercontent.com/u/1472352?v=3",
  "raw": {
    "login": "overtrue",
    "id": 1472352,
    "avatar_url": "https://avatars.githubusercontent.com/u/1472352?v=3",
    "gravatar_id": "",
    "url": "https://api.github.com/users/overtrue",
    "html_url": "https://github.com/overtrue",
    ...
  },
  "token_response": {
    "access_token": "5b1dc56d64fffbd052359f032716cc4e0a1cb9a0",
    "token_type": "bearer",
    "scope": "user:email"
  }
}

您可以通过以下数组键获取用户属性

$user['id'];        // 1472352
$user['nickname'];  // "overtrue"
$user['name'];      // "安正超"
$user['email'];     // "anzhengchao@gmail.com"
...

或者使用该方法

mixed   $user->getId();
?string $user->getNickname();
?string $user->getName();
?string $user->getEmail();
?string $user->getAvatar();
?string $user->getRaw();
?string $user->getAccessToken(); 
?string $user->getRefreshToken();
?int    $user->getExpiresIn();
?array  $user->getTokenResponse();

获取 OAuth API 的原始响应

$user->getRaw() 方法将返回 API 原始响应的 数组。

当您使用 userFromCode() 时获取令牌响应

$user->getTokenResponse() 方法将返回获取令牌（访问令牌）API响应的 数组。

注意：此方法仅在您使用 userFromCode() 时返回一个有效的 数组，否则将返回 null，因为使用 userFromToken() 没有令牌响应。

使用访问令牌获取用户

$accessToken = 'xxxxxxxxxxx';
$user = $socialite->userFromToken($accessToken);

享受它！ ❤️

参考

• 支付宝 - 用户信息授权
• 钉钉 - 扫码登录第三方网站
• Google - OpenID Connect
• Github - 授权 OAuth 应用
• Facebook - Graph API
• LinkedIn - 使用 OAuth 2.0 进行身份验证
• 微博 - OAuth 2.0 授权机制说明
• QQ - OAuth 2.0 登录QQ
• 腾讯云 - OAuth2.0
• 微信公众平台 - OAuth 文档
• 微信开放平台 - 网站应用微信登录开发指南
• 微信开放平台 - 代公众号发起网页授权
• 豆瓣 - OAuth 2.0 授权机制说明
• 抖音 - 网站应用开发指南
• 飞书 - 授权说明
• Tapd - 用户授权说明

PHP 扩展包开发

想知道如何从零开始构建 PHP 扩展包吗？

请关注我的实战课程，我将在该课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》

许可

MIT