cason-web-dev / laravel-azure-ad-oauth
为启用 Microsoft Azure Active Directory 的应用程序提供单点登录功能。
Requires
- guzzlehttp/guzzle: ^v7.8.0
- laravel/framework: ^v10.0.0
- laravel/socialite: ^v5.9.0
This package is auto-updated.
Last update: 2024-09-12 03:03:09 UTC
README
安装
composer require metrogistics/laravel-azure-ad-oauth
如果你使用的是 Laravel 5.5 或更高版本,服务提供程序将由 Laravel 自动检测和安装。否则,您需要将服务提供程序和外观(可选)添加到 config/app.php
文件中
Metrogistics\AzureSocialite\ServiceProvider::class,
// ...
'AzureUser' => Metrogistics\AzureSocialite\AzureUserFacade::class,
发布配置并覆盖任何默认设置
php artisan vendor publish
添加必要的环境变量
AZURE_AD_CLIENT_ID=XXXX
AZURE_AD_CLIENT_SECRET=XXXX
您需要更改应用程序的只有
- 您需要将用户表中的密码字段设置为可空。
- 您需要在用户表中有一个
VARCHAR
字段,长度为 36 个字符,用于存储用户的 Azure AD ID。字段的默认名称为azure_id
,但可以在配置文件中更改:'user_id_field' => 'azure_id',
。
使用方法
要使用 Azure AD SSO,您只需将用户指向(可配置的)/login/microsoft
路由进行登录。一旦用户登录,他们将被重定向到主页(也可配置)。
登录后,您可以像通常一样访问基本 Laravel 认证用户。
auth()->user();
如果您需要在登录时创建用户模型时设置额外的用户字段,您可以通过 UserFactory::userCallback()
方法提供一个回调。这样做的好地方是在 AppServiceProvider 的 boot
方法中。
\Metrogistics\AzureSocialite\UserFactory::userCallback(function($new_user){
$new_user->api_token = str_random(60);
});
Azure AD 设置
-
导航到
Azure Active Directory
->应用程序注册
。 -
创建一个新的应用程序
-
选择一个名称
-
选择 "Web 应用/ API" 应用程序类型
-
添加 "登录 URL"。这通常是
https://domain.com/auth/login
-
点击 "创建"
-
点击新创建的应用程序。
-
"应用程序 ID" 是您需要用于
AZURE_AD_CLIENT_ID
环境变量的值。 -
点击 "回复 URL"。您需要在此处将应用程序的重定向路径列入白名单。它通常是
https://domain.com/login/microsoft/callback
。点击 "保存" -
在 "所需权限" 选项卡中,选择您应用程序所需的权限。
-
将任何必要的角色添加到清单中
-
点击 "清单" 选项卡。
-
使用以下格式根据需要添加角色
"appRoles": [ { "allowedMemberTypes": [ "User" ], "displayName": "Manager Role", "id": "08b0e9e3-8d88-4d99-b630-b9642a70f51e",// Any unique GUID "isEnabled": true, "description": "Manage stuff with this role", "value": "manager" } ],
-
点击 "保存"
-
在 "密钥" 选项卡中,输入描述(例如 "应用程序密钥")。将持续时间设置为 "永不失效"。点击 "保存"。复制整个密钥。这不会再次显示。您需要此值用于
AZURE_AD_CLIENT_SECRET
环境变量。 -
点击 "托管应用程序" 链接(它将是应用程序的名称);
-
在 "属性" 选项卡下,启用用户登录。启用用户分配要求。点击 "保存"。
-
在 "用户和组" 选项卡下,根据需要添加用户及其角色。