erudion / socialite
erudion 和 ANG 周围的 OAuth 1 & OAuth 2 库的 Laravel 包装器
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~5.0|~6.0
- illuminate/contracts: ~5.0
- illuminate/http: ~5.0
- illuminate/support: ~5.0
- league/oauth1-client: ~1.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
README
介绍
Laravel Socialite 提供了对 Facebook、Twitter、Google、LinkedIn、GitHub 和 Bitbucket 进行 OAuth 认证的流畅接口。它几乎处理了所有您不愿编写的样板社交认证代码。
许可证
Laravel Socialite 是开源软件,许可协议为 MIT 协议
官方文档
除了典型的基于表单的认证外,Laravel 还通过 Laravel Socialite 提供了一种简单方便的方式使用 OAuth 提供商进行认证。Socialite 目前支持与 Facebook、Twitter、LinkedIn、Google、GitHub 和 Bitbucket 进行认证。
要开始使用 Socialite,请将其添加到您的 composer.json
文件中作为依赖项
composer require erudion/socialite
配置
安装 Socialite 库后,在您的 config/app.php
配置文件中注册 Laravel\Socialite\SocialiteServiceProvider
'providers' => [
// Other service providers...
Laravel\Socialite\SocialiteServiceProvider::class,
],
此外,将 Socialite
门面添加到您的 app
配置文件中的 aliases
数组中
'Socialite' => Laravel\Socialite\Facades\Socialite::class,
您还需要添加应用程序使用的 OAuth 服务的凭据。这些凭据应放在您的 config/services.php
配置文件中,并使用 facebook
、twitter
、linkedin
、google
、github
、bitbucket
、erudion
和 'ang' 等键,具体取决于应用程序所需的提供者。例如
'erudion' => [
'client_id' => 'your-erudion-app-id',
'client_secret' => 'your-erudion-app-secret',
'redirect' => 'http://your-callback-url',
],
基本用法
接下来,您就可以开始用户认证了!您需要两个路由:一个用于将用户重定向到 OAuth 提供商,另一个用于在认证后接收来自提供者的回调。我们将通过 Socialite
门面访问 Socialite
<?php
namespace App\Http\Controllers;
use Socialite;
class AuthController extends Controller
{
/**
* Redirect the user to the GitHub authentication page.
*
* @return Response
*/
public function redirectToProvider()
{
return Socialite::driver('erudon')->redirect();
}
/**
* Obtain the user information from GitHub.
*
* @return Response
*/
public function handleProviderCallback()
{
$user = Socialite::driver('erudion')->user();
// $user->token;
}
}
redirect
方法负责将用户发送到 OAuth 提供商,而 user
方法将读取传入的请求并从提供者检索用户信息。在重定向用户之前,您也可以使用 scope
方法在请求上设置 "作用域"。此方法将覆盖所有现有作用域
return Socialite::driver('erudion')->redirect();
当然,您需要定义路由到您的控制器方法
Route::get('auth/erudion', 'Auth\AuthController@redirectToProvider');
Route::get('auth/erudion/callback', 'Auth\AuthController@handleProviderCallback');
许多 OAuth 提供商支持在重定向请求中包含可选参数。要包括请求中的任何可选参数,请使用关联数组调用 with
方法
return Socialite::driver('google')
->with(['hd' => 'example.com'])->redirect();
检索用户详细信息
一旦您有了用户实例,您就可以获取更多有关用户的信息
$user = Socialite::driver('erudion')->user();
// OAuth Two Providers
$token = $user->token;
// OAuth One Providers
$token = $user->token;
$tokenSecret = $user->tokenSecret;
// All Providers
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();