MDP.AspNetCore.Authentication.GitHub

MDP.AspNetCore.Authentication.GitHub擴充ASP.NET Core既有的身分驗證，加入GitHub身分驗證功能。開發人員可以透過Config設定，掛載在專案裡使用的GitHub身分驗證，用以驗證GitHub帳號登入的使用者。

說明文件：https://mdpcore.github.io/MDP.AspNetCore/
程式源碼：https://github.com/MDPCore/MDP.AspNetCore/

模組使用

申請服務

MDP.AspNetCore.Authentication.GitHub使用GitHub官方提供的OAuth服務來進行身分驗證，依照下列操作步驟，即可申請官方所提供的OAuth服務。

1.註冊並登入GitHub Developer Settings。於OAuth Apps頁簽，點擊Register a new application按鈕，依照頁面提示建立一個Application，並編輯「Authorization callback URL」。(Callback URL=「程式執行網址」+「/.auth/login/github/callback」)

01.建立Application01.png

01.建立Application02.png

2.於Application頁面，進入General頁簽，取得「Client ID」、並且點擊Generate a new client secret按鈕以取得「Client secret」。

02.取得參數01.png

02.取得參數02.png

加入專案

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

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

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

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

MDP.AspNetCore.Authentication.GitHub

設定參數

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

// Config設定
{
  "Authentication": {
    "GitHub": {
      "ClientId": "xxxxx",
      "ClientSecret": "xxxxx"
    }
  }
}

- 命名空間：Authentication
- 掛載的身分驗證模組：GitHub
- GitHub身分驗證模組的客戶編號：ClientId="xxxxx"。(xxxxx填入Client ID)
- GitHub身分驗證模組的客戶密碼：ClientSecret="xxxxx"。(xxxxx填入Client secret)

模組範例

提供GitHub身分驗證，讓使用者能夠快速登入系統，是開發系統時常見的功能需求。本篇範例協助開發人員使用MDP.AspNetCore.Authentication.GitHub，逐步完成必要的設計和實作。

範例下載：WebApplication1.zip

操作步驟

1.開啟命令提示字元，輸入下列指令。用以安裝MDP.WebApp範本、並且建立一個名為WebApplication1的Web站台。

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

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

MDP.AspNetCore.Authentication.GitHub

3.依照模組使用-申請服務的步驟流程，申請GitHub身分驗證服務，並取得「Client ID」、「Client secret」。

05.申請服務01.png

4.於專案內改寫appsettings.json，填入「Client ID」、「Client secret」，用以掛載GitHub身分驗證。

{
  "Authentication": {
    "GitHub": {
      "ClientId": "xxxxx",
      "ClientSecret": "xxxxx"
    }
  }
}

5.改寫專案內的Controllers\AccountController.cs、Views\Account\Login.cshtml，提供Login頁面及GitHub身分驗證功能。

using MDP.AspNetCore.Authentication;
using MDP.AspNetCore.Authentication.GitHub;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace WebApplication1
{
    public class AccountController : Controller
    {
        // Methods
        [AllowAnonymous]
        public ActionResult Login()
        {
            // Return
            return this.View();
        }

        [AllowAnonymous]
        public Task<ActionResult> Logout()
        {
            // Return
            return this.LogoutAsync();
        }

        [AllowAnonymous]
        public Task<ActionResult> LoginByGitHub(string returnUrl = null)
        {
            // Return
            return this.LoginAsync(GitHubDefaults.AuthenticationScheme, returnUrl);
        }
    }
}

@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
@{

}
<!DOCTYPE html>

<html>
<head>
    <!-- title -->
    <title>Login</title>

    <!-- meta -->
    <meta charset="utf-8" />
</head>
<body>

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

    <!--LoginByGitHub-->
    <form asp-controller="Account" asp-action="LoginByGitHub" asp-route-returnUrl="@Context.Request.Query["ReturnUrl"]" method="post">
        <input type="submit" value="LoginByGitHub" /><br />
        <br />
    </form>
    <hr />

</body>
</html>

6.改寫專案內的Controllers\HomeController.cs、Views\Home\Index.cshtml，提供需登入才能進入的Home頁面，並於該頁面顯示目前登入的身分資料。

using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace WebApplication1
{
    public class HomeController : Controller
    {
        // Methods
        [Authorize]
        public ActionResult Index()
        {
            // Return
            return this.View();
        }
    }
}

@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
@using System.Security.Claims
@{
    string GetClaimValue(string claimType)
    {
        return (User?.Identity as ClaimsIdentity)?.FindFirst(claimType)?.Value;
    }
}
<!DOCTYPE html>

<html>
<head>
    <!-- title -->
    <title>Home</title>

    <!-- meta -->
    <meta charset="utf-8" />
</head>
<body>

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

    <!--Identity-->
    AuthenticationType=@User?.Identity?.AuthenticationType<br />
    UserId=@GetClaimValue(ClaimTypes.NameIdentifier)<br />
    Username=@GetClaimValue(ClaimTypes.Name)<br />
    Mail=@GetClaimValue(ClaimTypes.Email)<br />
    <br />
    <hr />

    <!--Logout-->
    <form asp-controller="Account" asp-action="Logout">
        <input type="submit" value="Logout" /><br />
        <br />
    </form>
    <hr />

</body>
</html>

7.執行專案，於開啟的Browser視窗內，可以看到系統畫面進入到Login頁面。(預設是開啟Home頁面，但是因為還沒登入，所以跳轉到Login頁面)

06.LoginPage01.png

8.於Login頁面，點擊LoginByGitHub按鈕。Browser視窗會跳轉至GitHub身分驗證服務的頁面，進行OAuth身分驗證。

07.OAuthPage01.png

9.於GitHub身分驗證服務完成身分驗證之後，Browser視窗會跳轉回原系統的Home頁面，並且顯示登入的身分資料。(經由GitHub身分驗證登入)

08.HomePage01.png