mirzaazrim/laravel-ad-azure

该软件包最新版本(dev-master)没有提供许可信息。

为启用Microsoft Azure Active Directory的应用程序提供单点登录功能。

dev-master 2024-10-02 07:37 UTC

This package is not auto-updated.

Last update: 2024-10-03 06:08:43 UTC


README

安装

composer require mirzaazrim/laravel-ad-azure

如果你使用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

你需要在应用中进行的唯一更改是

  • 你需要将用户表中的密码字段设置为可空的。
  • 你需要在用户表中添加一个36个字符长的VARCHAR字段来存储用户的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 设置

  1. 导航到Azure Active Directory -> 应用程序注册

  2. 创建一个新应用程序

  3. 选择一个名称

  4. 选择“Web应用/ API”应用程序类型

  5. 添加“登录URL”。这通常是https://domain.com/auth/login

  6. 点击“创建”

  7. 点击新创建的应用程序。

  8. “应用程序ID”是你需要用于AZURE_AD_CLIENT_ID环境变量的。

  9. 点击“回复URL”。你需要在此处为你的应用程序白名单重定向路径。这通常是https://domain.com/login/microsoft/callback。点击“保存”

  10. 在“所需权限”选项卡中,选择应用程序所需的权限。

  11. 将任何必要的角色添加到清单中

  12. 点击“清单”选项卡。

  13. 使用以下格式添加必要的角色

      "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"
          }
        ],
    
  14. 点击“保存”

  15. 在“密钥”选项卡中,输入一个描述(例如“应用程序密钥”)。将持续时间设置为“永不失效”。点击“保存”。复制整个密钥。这将不再显示。你需要此值用于AZURE_AD_CLIENT_SECRET环境变量。

  16. 点击“托管应用程序”链接(它将是应用程序的名称);

  17. 在“属性”选项卡下,启用用户登录。要求用户分配。点击“保存”。

  18. 在“用户和组”选项卡下,根据需要添加用户及其角色。