[MDP.NetCore] 使用AzureAD+受控識別，快速建立兩個服務之間的Service身分認證

MDP.AspNetCore.Authentication.AzureAD.Services for Managed Identity

MDP.AspNetCore.Authentication.AzureAD.Services擴充ASP.NET Core既有的身分驗證，加入AzureAD提供的Service身分驗證功能。開發人員可以透過Config設定，掛載在專案裡使用的Service身分驗證，用以驗證Azure裡的受控識別(Managed Identity)。

說明文件：https://clark159.github.io/MDP.AspNetCore.Authentication/
程式源碼：https://github.com/Clark159/MDP.AspNetCore.Authentication/
特別說明1：本篇範例的 API客戶端必需在Azure環境佈署執行、API服務端不限制在Azure環境部署執行。
特別說明2：本篇範例的 API客戶端、API服務端，兩者皆無需持有Secret。

運作流程

MDP.AspNetCore.Authentication.AzureAD.Services使用AzureAD提供的OAuth服務，透過Client Credentials流程來進行Service身分驗證，用以驗證Azure裡的受控識別(Managed Identity)。下列兩個運作流程，說明AzureAD的憑證發放流程、服務驗證流程。(內容為簡化說明，完整細節可參考AzureAD文件)

憑證發放

Service身分驗證-憑證發放.png

0.建立Azure資源，用來執行API Client應用程式時，Azure資源內會同時掛載IMDS服務(Azure Instance Metadata Service)。

1.開發人員至AzureAD，在執行API Client應用程式的Azure資源內，開啟系統指派的受控識別(Managed Identity)。

2.AzureAD建立API Client的身分憑證，發送給IMDS服務儲存。

3.開發人員至AzureAD，建立API Provider的應用程式註冊。

4.開發人員從AzureAD，取得API Provider的身分憑證，內容包含：TenantId、ClientId。(沒有ClientSecret)

5.開發人員將API Provider的身分憑證，設定在API Provider應用程式的Config參數。

服務驗證

Service身分驗證-服務驗證.png

1.使用者開啟API Client提供的URL。

2.API Client發送GetToken指令，給同Azure資源內的IMDS服務。

3.IMDS服務從儲存空間，取得API Client的身分憑證發送給AzureAD，內容包含：TenantId、ClientId、ClientSecret。

4.AzureAD依照API Client的身分憑證，使用內建的公私鑰加密機制，回傳代表API Client的AccessToken。

5.IMDS服務，回傳代表API Client的AccessToken。

6.API Client調用API，並且將AccessToken放置在API Request封包的Header。

7.API Provider從Config參數，取得API Provider的身分憑證發送給AzureAD，內容包含：TenantId、ClientId。(沒有ClientSecret)

8.AzureAD依照API Provider的身分憑證，使用內建的公私鑰管理機制，回傳可以驗證AccessToken的公鑰(Public Key)。

9.API Provider使用Public Key驗證AccessToken簽章，確認合法就依照系統邏輯回傳API Response。(不合法回傳401 Unauthorized)

10.API Client依照API Response，回傳Page給使用者。

模組使用-API服務端(API Provider)

申請服務

MDP.AspNetCore.Authentication.AzureAD.Services使用AzureAD提供的OAuth服務，透過Client Credentials流程來進行Service身分驗證。依照下列操作步驟，即可申請AzureAD提供給API服務端(API Provider)的身分憑證。

1.註冊並登入Microsoft Azure Portal。於首頁左上角的選單裡，點擊應用程式註冊後，進入應用程式註冊頁面。於應用程式註冊頁面，點擊新增註冊按鈕，依照頁面提示建立一個Application。

01.建立Application01.png

01.建立Application02.png

01.建立Application03.png

2.建立完畢後，於Application頁面，點擊新增應用程式識別碼 URI按鈕，進入公開API頁面，然後點擊新增，依照頁面提示建立一個「應用程式識別碼 URI」。建立完畢後，於Application頁面取得：API服務端的「目錄 (租用戶) 識別碼」、「應用程式 (用戶端) 識別碼」、「應用程式識別碼 URI」。

03.取得參數01.png

03.取得參數02.png

03.取得參數03.png

03.取得參數04.png

3.於Application頁面，點擊左側選單的應用程式角色，進入應用程式角色頁面。然後點擊建立應用程式角色，依照頁面提示建立一個「應用程式角色」。建立完畢後，於應用程式角色頁面取得：API服務端的「應用程式角色識別碼」。

04.建立角色01.png

04.建立角色02.png

04.建立角色03.png

4.於Application頁面，點擊中頁面內容的本機目錄中受控的應用程式，進入企業應用程式頁面。並於企業應用程式頁面，取得：API服務端的「物件識別碼」。

05.取得識別碼01.png

05.取得識別碼02.png

加入專案

申請服務完成之後，就可以開始建立專案並且加入模組。MDP.AspNetCore.Authentication.AzureAD.Services預設獨立在MDP.Net專案範本外，依照下列操作步驟，即可建立加入MDP.AspNetCore.Authentication.AzureAD.Services的專案。

在命令提示字元輸入下列指令，使用MDP.Net專案範本建立專案。

dotnet new install MDP.WebApp
dotnet new MDP.WebApp -n ApiProvider

使用Visual Studio開啟專案。在專案裡使用NuGet套件管理員，新增下列NuGet套件。

MDP.AspNetCore.Authentication.AzureAD.Services

設定參數

建立包含MDP.AspNetCore.Authentication.AzureAD.Services的專案之後，就可以透過Config設定，掛載在專案裡使用的Service身分驗證。

// Config設定
{
  "Authentication": {
    "AzureAD.Services": {
      "TenantId": "xxxxx",
      "ClientId": "xxxxx"
    }
  }
}

- 命名空間：Authentication
- 掛載的身分驗證模組：AzureAD.Services
- API服務端的租戶編號：TenantId="xxxxx"。(xxxxx填入API服務端的「目錄 (租用戶) 識別碼」)
- API服務端的客戶編號：ClientId="xxxxx"。(xxxxx填入API服務端的「應用程式 (用戶端) 識別碼」)

模組使用-API客戶端(API Client)

申請服務(API Client)

MDP.AspNetCore.Authentication.AzureAD.Services使用AzureAD提供的OAuth服務，透過Client Credentials流程來進行Service身分驗證。依照下列操作步驟，即可申請API客戶端(API Client)的受控識別，用以提供身分憑證。

1.建立Azure資源(例如：Azure VM、App Service、Container Apps)，用來執行API客戶端程式。

11.建立受控識別01.png

2.執行API客戶端程式的Azure資源，建立完畢之後。進入該Azure資源頁面，點擊左側選單的身分識別，進入身分識別頁面。然後點擊開啟，依照頁面提示開啟系統指派的受控識別，並取得API客戶端的「物件 (主體) 識別碼」。

11.建立受控識別02.png

11.建立受控識別03.png

3.回到Azure Portal。於右上角的選單裡，點擊Cloud Shell按鈕後，開啟Cloud Shell視窗。於Cloud Shell視窗，切換至Bash並執行下列指令，新增API服務端的「應用程式角色」給API客戶端。

az rest \
-m POST \
--headers "Content-Type=application/json" \
-u "https://graph.microsoft.com/v1.0/servicePrincipals/xxxClient-PrincipalIdxxx/appRoleAssignments" \
-b "{
    \"principalId\": \"xxxClient-PrincipalIdxxx\", 
    \"resourceId\": \"xxxProvider-ResourceIdxxx\", 
    \"appRoleId\": \"xxxProvider-AppRoleIdxxx\"
}"

- API客戶端的物件識別碼：xxxClient-PrincipalIdxxx。(xxxClient-PrincipalIdxxx填入先前取得的API客戶端「物件 (主體) 識別碼」。注意!有兩個地方要改。)
- API服務端的物件識別碼：xxxProvider-ResourceIdxxx。(xxxProvider-ResourceIdxxx填入先前取得的API服務端「物件識別碼」)
- API服務端的角色識別碼：xxxProvider-AppRoleIdxxx。(xxxProvider-AppRoleIdxxx填入先前取得的API服務端「應用程式角色識別碼」)

12.建立授權01.png

12.建立授權02.png

4.回到Azure Portal。於首頁左上角的選單裡，點擊企業應用程式後，進入企業應用程式頁面。於企業應用程式頁面，可以找到API客戶端(API Client)的受控識別。點擊後，進入API客戶端(API Client)的受控識別頁面，選擇左側選單裡的權限頁籤，可以看到授權給API客戶端的權限。(這頁也可以撤銷權限)

13.檢視授權01.png

13.檢視授權02.png

13.檢視授權03.png

加入專案

申請服務完成之後，就可以開始建立專案並且加入模組。Azure.Identity預設獨立在MDP.Net專案範本外，依照下列操作步驟，即可建立加入Azure.Identity的專案。

在命令提示字元輸入下列指令，使用MDP.Net專案範本建立專案。

dotnet new install MDP.WebApp
dotnet new MDP.WebApp -n ApiClient

使用Visual Studio開啟專案。在專案裡使用NuGet套件管理員，新增下列NuGet套件。

Azure.Identity

使用憑證

建立包含Azure.Identity的專案之後，就可以在程式碼裡使用受控識別，建立代表API客戶端身分的AccessToken，用來通過API服務端的Service身分驗證。(必需在Azure資源執行)

// 參數設定
var azureCredential = new DefaultAzureCredential();
var apiProviderURI= "api://xxxxx";
var apiProviderEndpoint= "https://xxxxx/Home/Index";

- API服務端的應用程式識別碼URI: apiProviderURI= "api://xxxxx"。(xxxxx填入API服務端的「應用程式識別碼URI」)
- API服務端的API服務端點: apiProviderEndpoint= "https://xxxxx/Home/Index"。(https://xxxxx/Home/Index填入API服務端的API服務端點)

// 建立AccessToken
var accessToken = (await azureCredential.GetTokenAsync(new Azure.Core.TokenRequestContext(new string[] { $"{apiProviderURI}/.default" }), default)).Token;

// 呼叫API服務端點
var responseContent = string.Empty;
using (var httpClient = new HttpClient())
{
    // Headers
    httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", accessToken);

    // Send
    var response = await httpClient.GetAsync(apiProviderEndpoint);
    responseContent = await response?.Content?.ReadAsStringAsync();
}

模組範例

使用AzureAD提供的Service身分驗證功能，進行 Service to Service 之間的身分驗證，是開發系統時常見的功能需求。本篇範例協助開發人員使用MDP.AspNetCore.Authentication.AzureAD.Services，逐步完成必要的設計和實作。

範例下載：ApiClient.zip
範例下載：ApiProvider.zip
特別說明1：本篇範例的 API客戶端必需在Azure環境佈署執行、API服務端不限制在Azure環境部署執行。
特別說明2：本篇範例的 API客戶端、API服務端，兩者皆無需持有Secret。

建立API服務端(API Provider)

1.依照開發一個從GitHub持續佈署到Azure Container Apps的Web站台的步驟流程，建立：api-provider容器應用、ApiProvider程式專案，並且取得API服務端的：「應用程式 URL」。

21.申請服務01.png

21.申請服務02.png

2.依照模組使用-API服務端(API Provider)-申請服務的步驟流程，申請AzureAD提供的OAuth服務，並取得API服務端的：「目錄 (租用戶) 識別碼」、「應用程式 (用戶端) 識別碼」、「應用程式識別碼 URI」。

21.申請服務03.png

3.於專案內改寫appsettings.json，填入「目錄 (租用戶) 識別碼」、「應用程式 (用戶端) 識別碼」，用以掛載Service身分驗證。

{
  "Authentication": {
    "AzureAD.Services": {
      "TenantId": "xxxxx", // API服務端的「目錄 (租用戶) 識別碼」
      "ClientId": "xxxxx"  // API服務端的「應用程式 (用戶端) 識別碼」
    }
  }
}

4.改寫專案內的Controllers\HomeController.cs，提供一個必須通過身分驗證才能使用的API服務端點：\Home\Index。

using MDP.AspNetCore.Authentication.AzureAD.Services;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Linq;
using System.Security.Claims;

namespace ApiProvider
{
    public class HomeController : Controller
    {
        // Methods
        [Authorize]
        public string Index()
        {
            // ClaimsIdentity
            var claimsIdentity = this.User.Identity as ClaimsIdentity;
            if (claimsIdentity == null) throw new InvalidOperationException($"{nameof(claimsIdentity)}=null");
            Console.WriteLine($"this.User.AuthenticationType = {claimsIdentity.AuthenticationType}");
            Console.WriteLine($"this.User.TenantId = {claimsIdentity.FindFirst(AzureServicesAuthenticationClaimTypes.TenantId)?.Value}");
            Console.WriteLine($"this.User.ClientId = {claimsIdentity.FindFirst(AzureServicesAuthenticationClaimTypes.ClientId)?.Value}");
            Console.WriteLine($"this.User.Roles = {String.Join(",", claimsIdentity.FindAll(System.Security.Claims.ClaimTypes.Role).Select(o => o.Value))}");
            Console.WriteLine();
            
            // Return
            return "Hello World";
        }
    }
}

5.完成專案程式碼改寫的步驟之後，將程式碼簽入GitHub用以啟動GitHub Action流程，編譯並部署API服務端程式到Azure Container Apps。

21.申請服務04.png

建立API客戶端(API Client)

1.依照開發一個從GitHub持續佈署到Azure Container Apps的Web站台的步驟流程，建立：api-client容器應用、ApiClient程式專案，並且取得API客戶端的：「應用程式 URL」。

22.申請服務01.png

22.申請服務02.png

2.依照模組使用-API客戶端(API Client)-申請服務的步驟流程，開啟API客戶端的受控識別。

21.申請服務03.png

3.改寫專案內的Controllers\HomeController.cs、Views\Home\Index.cshtml，提供Home頁面。並於Home頁面使用受控識別憑證，建立代表API客戶端身分的AccessToken，用來通過API服務端的Service身分驗證後，取得資料顯示於頁面。

using Azure.Identity;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Net.Http;
using System.Threading.Tasks;

namespace ApiClient
{
    public class HomeController : Controller
    {
        // Methods
        public async Task<ActionResult> Index()
        {
            // Variables
            var azureCredential = new DefaultAzureCredential();
            var apiProviderURI = "api://xxxxx";                   // API服務端的「應用程式識別碼 URI」
            var apiProviderEndpoint = "https://xxxxx/Home/Index"; // API服務端的「應用程式 URL」+/Home/Index

            // AccessToken
            var accessToken = (await azureCredential.GetTokenAsync(new Azure.Core.TokenRequestContext(new string[] { $"{apiProviderURI}/.default" }), default)).Token;
            if (string.IsNullOrEmpty(accessToken) == true) throw new InvalidOperationException($"{nameof(accessToken)}=null");

            // Call API
            var responseContent = string.Empty;
            using (var httpClient = new HttpClient())
            {
                // Headers
                httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", accessToken);

                // Send
                var response = await httpClient.GetAsync(apiProviderEndpoint);
                responseContent = await response?.Content?.ReadAsStringAsync();
            }
            if (string.IsNullOrEmpty(responseContent) == true) throw new InvalidOperationException($"{nameof(responseContent)}=null");

            // ViewBag
            this.ViewBag.Message = responseContent;

            // Return
            return View();
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title>ApiClient</title>
</head>
<body>

    <!--Title-->
    <h2>ApiClient</h2>
    <hr />

    <!--Message-->
    <h3>@ViewBag.Message</h3>

</body>
</html>

5.完成專案程式碼改寫的步驟之後，將程式碼簽入GitHub用以啟動GitHub Action流程，編譯並部署API客戶端程式到Azure Container Apps。

22.申請服務04.png

範例執行

1.使用Browser視窗，開啟API客戶端的「應用程式 URL」。於開啟的Browser視窗內，可以看到系統畫面進入到Home頁面，並且顯示API服務端回傳的”Hello World”。

23.執行結果01.png

2.登入Microsoft Azure Portal。於API服務端的容器應用頁面，進入紀錄資料流頁籤，可以看到通過Service身分驗證的API客戶端身分資料(Controller.User屬性)，並且包含「應用程式角色」的資料。

23.執行結果02.png

posted @ 2023-11-30 21:11 Clark159 阅读(21) 评论(0) 编辑收藏举报

刷新页面返回顶部

昏睡領域

Clark的心得筆記

[MDP.NetCore] 使用AzureAD+受控識別，快速建立兩個服務之間的Service身分認證

MDP.AspNetCore.Authentication.AzureAD.Services for Managed Identity

運作流程

憑證發放

服務驗證

模組使用-API服務端(API Provider)

申請服務

加入專案

設定參數

模組使用-API客戶端(API Client)

申請服務(API Client)

加入專案

使用憑證

模組範例

建立API服務端(API Provider)

建立API客戶端(API Client)

範例執行

公告