README

composer require socialiteproviders/onelogin

安装与基本使用

请参阅基本安装指南，然后按照以下特定提供者的说明操作。

将配置添加到 config/services.php

'onelogin' => [
  'base_url' => env('ONELOGIN_BASE_URL'),
  'client_id' => env('ONELOGIN_CLIENT_ID'),
  'client_secret' => env('ONELOGIN_CLIENT_SECRET'),
  'redirect' => env('ONELOGIN_REDIRECT_URI')
],

添加提供者事件监听器

Laravel 11+

在 Laravel 11 中，默认的 EventServiceProvider 提供者已被移除。相反，您需要在 AppServiceProvider 的 boot 方法中使用 Event 门面上的 listen 方法来添加监听器。

• 注意：除非您使用自己的提供者覆盖了内置的社交提供者，否则您不需要添加任何内容。

Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('onelogin', \SocialiteProviders\Onelogin\Provider::class);
});

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Onelogin\OneloginExtendSocialite::class.'@handle',
    ],
];

使用方法

现在您应该能够像通常使用 Socialite 一样使用提供者（假设您已安装了门面）

return Socialite::driver('onelogin')->redirect();

在回调中存储本地副本

public function handleProviderCallback(\Illuminate\Http\Request $request)
{
    $user = Socialite::driver('onelogin')->user();
    $localUser = User::updateOrCreate(['email' => $user->email], [
        'email'         => $user->email,
        'name'          => $user->name,
        'token'         => $user->token,
        'id_token'      => $user->id_token,
        'refresh_token' => $user->refreshToken,
    ]);

    try {
        Auth::login($localUser);
    }
    catch (\Throwable $e) {
        return redirect('/login');
    }

    return redirect('/home');
}

从您的控制器生成注销 URL：注意：https://developers.onelogin.com/openid-connect/api/logout

public function logout(\Illuminate\Http\Request $request)
{
    $idToken = $request->user()->id_token;
    $logoutUrl = Socialite::driver('onelogin')->getLogoutUrl($idToken, URL::to('/'));
    Auth::logout();

    return redirect($logoutUrl);
}

刷新令牌

使用刷新令牌允许活动用户保持其会话

$localUser = Auth::user();
$response = (object) Socialite::driver('onelogin')
    ->setScopes(['offline_access'])
    ->getRefreshTokenResponse($localUser->refresh_token);

$localUser->token         = $response->access_token;
$localUser->refresh_token = $response->refresh_token;

$localUser->save();
Auth::setUser($localUser);

注意：获取 refresh_token 需要 initial login 的 offline_access 权限。

客户端令牌

获取用于无需用户即可验证到其他应用的客户端访问令牌

$response = (object) Socialite::driver('onelogin')->getClientAccessTokenResponse();
$token = $response->access_token;

注意：不缓存此令牌。强烈建议在本地缓存令牌以进行其 ttl。

撤销令牌

当与 introspection 端点进行核对时，标记令牌为已撤销

$repo = Socialite::driver('onelogin');
$repo->revokeToken($token, 'access_token');
// verify against introspection endpoint
$state = $repo->introspectToken($token, 'access_token');
if($state['active']){...};