socialiteproviders/authentik

Laravel Socialite 的 Authentik OAuth2 提供程序

维护者

详细信息

github.com/SocialiteProviders/Authentik

源代码

问题

文档

安装数: 17,116

依赖者: 0

建议者: 0

安全性: 0

星标: 4

关注者: 3

分支: 1

5.2.0 2023-11-07 22:21 UTC

Requires

MIT 4cf129cf04728a38e0531c54454464b162f0fa66

  • rf152 <git.woop@rf152.co.uk>

oauthproviderlaravelsocialiteauthentik

This package is auto-updated.

Last update: 2024-08-26 21:26:45 UTC

README

composer require socialiteproviders/authentik

安装与基本使用

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

在 Authentik 中准备 OAuth 提供程序和应用

根据 Authentik 文档（https://goauthentik.io/docs/providers/oauth2/）在 Authentik 中创建一个新的 OAuth 提供程序

将配置添加到 config/services.php

'authentik' => [
  'base_url' => env('AUTHENTIK_BASE_URL'),
  'client_id' => env('AUTHENTIK_CLIENT_ID'),
  'client_secret' => env('AUTHENTIK_CLIENT_SECRET'),
  'redirect' => env('AUTHENTIK_REDIRECT_URI')
],

添加提供程序事件监听器

Laravel 11+

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

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

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

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

使用方法

现在您应该可以使用提供程序，就像您通常使用 Socialite 一样（假设您已安装了门面）

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

重定向到身份验证，然后

$user = Socialite::driver('authentik')->user()

在返回函数中。用户将包含从 OAuth 源填充的 name 和 email 字段。