Kanidm OAuth2 提供商 for Laravel Socialite

5.0.0 2024-02-19 19:49 UTC

This package is auto-updated.

Last update: 2024-09-02 00:42:05 UTC


README

composer require socialiteproviders/kanidm

安装与基本使用

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

config/services.php 中添加配置

'kanidm' => [
  'client_id' => env('KANIDM_CLIENT_ID'),
  'client_secret' => env('KANIDM_CLIENT_SECRET'),
  'redirect' => env('KANIDM_REDIRECT_URI'),
  'base_url' => env('KANIDM_BASE_URL'),
],

.env 中添加基础 URL

Kanidm 可能需要您对自定义 URL 进行授权,您可以将此 URL 作为基础 URL 提供。

KANIDM_BASE_URL=https://idm.example.com/

添加提供者事件监听器

Laravel 11+

在 Laravel 11 中,默认的 EventServiceProvider 提供商已被移除。相反,您可以在 AppServiceProviderboot 方法中使用 Event 门面的 listen 方法添加监听器。

  • 注意:除非您使用自己的提供商覆盖它们,否则您不需要为内置的 Socialite 提供商添加任何内容。
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('kanidm', \SocialiteProviders\Kanidm\Provider::class);
});
Laravel 10 或以下配置包的监听器以监听 `SocialiteWasCalled` 事件。

将事件添加到 app/Providers/EventServiceProvider 中的 listen[] 数组中。有关详细说明,请参阅基本安装指南

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

使用方法

现在您应该能够像常规使用 Socialite 一样使用此提供商(假设您已安装门面)

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

返回的用户字段

  • id
  • 昵称
  • 姓名
  • 电子邮件