README

composer require socialiteproviders/okta

安装与基本使用

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

将配置添加到 config/services.php

'okta' => [    
  'base_url' => env('OKTA_BASE_URL'),
  'client_id' => env('OKTA_CLIENT_ID'),  
  'client_secret' => env('OKTA_CLIENT_SECRET'),  
  'redirect' => env('OKTA_REDIRECT_URI') 
],

多租户 SSO

如果您需要从多个 Okta 实例验证用户，您可以在调用 redirect/user 方法之前动态设置配置值。您仍然需要按照上述方式添加服务条目，但可以将所有值留为 null。

$config = new \SocialiteProviders\Manager\Config(
    'client_id',
    'client_secret',
    route('okta.callback'),
    [
        'base_url' => 'https://1234.okta.com',
    ]
);

\Laravel\Socialite\Facades\Socialite::driver('okta')
    ->setConfig($config)
    ->redirect();

自定义认证服务器

如果您使用 Okta 开发者，应适当设置 auth_server_id 配置选项。它应设置为 "default"，或设置为您的自定义授权服务器的服务器 ID。

有关更多信息，请参阅okta 文档。

添加提供程序事件监听器

Laravel 11+

在 Laravel 11 中，默认的 EventServiceProvider 提供程序已被移除。取而代之的是，在您的 AppServiceProvider 的 boot 方法中使用 Event 门面上的 listen 方法添加监听器。

• 注意：除非您使用自己的提供程序覆盖它们，否则您不需要为内置的 Socialite 提供程序添加任何内容。

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

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

使用方法

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

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

在回调中存储本地副本

public function handleProviderCallback(\Illuminate\Http\Request $request)
{
    $user = Socialite::driver('okta')->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-okta');
    }

    return redirect('/home');
}

从控制器中生成注销 URL

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

    return redirect($logoutUrl);
}

刷新令牌

使用刷新令牌允许活动用户维持他们的会话

$localUser = Auth::user();
$response = (object) Socialite::driver('okta')
    ->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 需要初始登录的 offline_access 范围。有关更多信息，请参阅此处的附加文档。

客户端令牌

获取用于在没有用户的情况下对其他应用程序进行认证的客户端访问令牌

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

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

撤销令牌

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

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

返回的用户字段

• id
• email
• email_verified
• nickname
• name
• first_name
• last_name
• profileUrl
• address
• phone