credit-union-2-0-llc/laravel-azure-ad-oauth

本包的最新版本(v1.6.0)没有提供许可证信息。

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

v1.6.0 2019-02-25 14:59 UTC

This package is auto-updated.

Last update: 2024-09-26 03:54:00 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

你只需对应用程序进行以下更改

  • 你需要将用户表中密码字段设置为可为空。
  • 你需要在用户表中添加一个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. 在“用户和组”选项卡下,根据需要添加用户及其角色。