一、前言
在上一篇關於簡化模式中，通過客戶端以瀏覽器的形式請求IdentityServer服務獲取訪問令牌，從而請求獲取受保護的資源，但由於token攜帶在url中，安全性方面不能保證。因此，我們可以考慮通過其他方式來解決這個問題。
我們通過Oauth2.0的授權碼模式瞭解，這種模式不同於簡化模式，在於授權碼模式不直接返回token，而是先返回一個授權碼，然後再根據這個授權碼去請求token。這顯得更為安全。
所以在這一篇中，我們將通過多種授權模式中的授權碼模式進行說明，主要針對介紹IdentityServer保護API的資源，授權碼訪問API資源。
二、初識
(圖片來源網路)
指的是第三方應用先申請一個授權碼，然後再用該碼獲取令牌，實現與資源伺服器的通訊。
看一個常見的QQ登陸第三方網站的流程如下圖所示：
2.1 適用範圍
授權碼模式(authorization code)是功能最完整、流程最嚴密的授權模式。
授權碼模式適用於有後端的應用，因為客戶端根據授權碼去請求token時是需要把客戶端密碼轉進來的，為了避免客戶端密碼被暴露，所以請求token這個過程需要放在後臺。
2.2 授權流程：
+----------+
| Resource |
| Owner |
| |
+----------+
^
|
(B)
+----|-----+ Client Identifier +---------------+
| -+----(A)-- & Redirection URI ---->| |
| User- | | Authorization |
| Agent -+----(B)-- User authenticates --->| Server |
| | | |
| -+----(C)-- Authorization Code ---<| |
+-|----|---+ +---------------+
| | ^ v
(A) (C) | |
| | | |
^ v | |
+---------+ | |
| |>---(D)-- Authorization Code ---------' |
| Client | & Redirection URI |
| | |
| |<---(E)----- Access Token -------------------'
+---------+ (w/ Optional Refresh Token)
授權碼授權流程描述
（A）使用者訪問第三方應用，第三方應用將使用者導向認證伺服器；
（B）使用者選擇是否給予第三方應用授權；
（C）假設使用者給予授權，認證伺服器將使用者導向第三方應用事先指定的重定向URI，同時帶上一個授權碼；
（D）第三方應用收到授權碼，帶上上一步時的重定向URI，向認證伺服器申請訪問令牌。這一步是在第三方應用的後臺的伺服器上完成的，對使用者不可見；
（E）認證伺服器核對了授權碼和重定向URI，確認無誤後，向第三方應用傳送訪問令牌(Access Token)和更新令牌(Refresh token)；
（F）訪問令牌過期後，重新整理訪問令牌；
2.2.1 過程詳解
訪問令牌請求
（1）使用者訪問第三方應用，第三方應用將使用者導向認證伺服器
(使用者的操作：使用者訪問https://client.example.com/cb跳轉到登入地址，選擇授權伺服器方式登入)
在授權開始之前，它首先生成state引數(隨機字串)。client端將需要儲存這個（cookie，會話或其他方式），以便在下一步中使用。
GET /authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz
&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1
HTTP/1.1 Host: server.example.com
生成的授權URL如上所述（如上），請求這個地址後重定向訪問授權伺服器，其中 response_type引數為code,表示授權型別，返回code授權碼。
| 引數 | 是否必須 | 含義 |
|---|---|---|
| response_type | 必需 | 表示授權型別，此處的值固定為"code" |
| client_id | 必需 | 客戶端ID |
| redirect_uri | 可選 | 表示重定向的URI |
| scope | 可選 | 表示授權範圍。 |
| state | 可選 | 表示隨機字串,可指定任意值，認證伺服器會返回這個值 |
（2）假設使用者給予授權，認證伺服器將使用者導向第三方應用事先指定的重定向URI，同時帶上一個授權碼
HTTP/1.1 302 Found
Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
| 引數 | 含義 |
|---|---|
| code | 表示授權碼，必選項。該碼的有效期應該很短，通常設為10分鐘，客戶端只能使用該碼一次，否則會被授權伺服器拒絕。該碼與客戶端ID和重定向URI，是一一對應關係。 |
| state | 如果客戶端的請求中包含這個引數，認證伺服器的回應也必須一模一樣包含這個引數。 |
（3）第三方應用收到授權碼，帶上上一步時的重定向URI，向認證伺服器申請訪問令牌。這一步是在第三方應用的後臺的伺服器上完成的，對使用者不可見。
POST /token HTTP/1.1
Host: server.example.com
Authorization: Bearer czZCaGRSa3F0MzpnWDFmQmF0M2JW
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA
&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
| 引數 | 含義 |
|---|---|
| grant_type | 表示使用的授權模式，必選項，此處的值固定為"authorization_code"。 |
| code | 表示上一步獲得的授權碼，必選項。 |
| redirect_uri | 表示重定向URI，必選項，且必須與步驟1中的該引數值保持一致。 |
| client_id | 表示客戶端ID，必選項。 |
（4）認證伺服器核對了授權碼和重定向URI，確認無誤後，向第三方應用傳送訪問令牌(Access Token)和更新令牌(Refresh token)
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"access_token":"2YotnFZFEjr1zCsicMWpAA",
"token_type":"Bearer",
"expires_in":3600,
"refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
"example_parameter":"example_value"
}
| 引數 | 含義 |
|---|---|
| access_token | 表示訪問令牌，必選項。 |
| token_type | 表示令牌型別，該值大小寫不敏感，必選項，可以是Bearer型別或mac型別。 |
| expires_in | 表示過期時間，單位為秒。如果省略該引數，必須其他方式設定過期時間。 |
| refresh_token | 表示更新令牌，用來獲取下一次的訪問令牌，可選項。 |
| scope | 表示許可權範圍，如果與客戶端申請的範圍一致，此項可省略。 |
(5) 訪問令牌過期後，重新整理訪問令牌
POST /token HTTP/1.1
Host: server.example.com
Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
| 引數 | 含義 |
|---|---|
| granttype | 表示使用的授權模式，此處的值固定為"refreshtoken"，必選項。 |
| refresh_token | 表示早前收到的更新令牌，必選項。 |
| scope | 表示申請的授權範圍，不可以超出上一次申請的範圍，如果省略該引數，則表示與上一次一致。 |
三、實踐
在示例實踐中，我們將建立一個授權訪問服務，定義一個MVC客戶端，MVC客戶端通過IdentityServer上請求訪問令牌，並使用它來訪問API。
3.1 搭建 Authorization Server 服務
搭建認證授權服務
3.1.1 安裝Nuget包
IdentityServer4程式包
3.1.2 配置內容
建立配置內容檔案Config.cs
public static class Config
{
public static IEnumerable<IdentityResource> IdentityResources =>
new IdentityResource[]
{
new IdentityResources.OpenId(),
new IdentityResources.Profile(),
};
public static IEnumerable<ApiScope> ApiScopes =>
new ApiScope[]
{
new ApiScope("code_scope1")
};
public static IEnumerable<ApiResource> ApiResources =>
new ApiResource[]
{
new ApiResource("api1","api1")
{
Scopes={ "code_scope1" },
UserClaims={JwtClaimTypes.Role}, //新增Cliam 角色型別
ApiSecrets={new Secret("apipwd".Sha256())}
}
};
public static IEnumerable<Client> Clients =>
new Client[]
{
new Client
{
ClientId = "code_client",
ClientName = "code Auth",
AllowedGrantTypes = GrantTypes.Code,
RedirectUris ={
"http://localhost:5002/signin-oidc", //跳轉登入到的客戶端的地址
},
// RedirectUris = {"http://localhost:5002/auth.html" }, //跳轉登出到的客戶端的地址
PostLogoutRedirectUris ={
"http://localhost:5002/signout-callback-oidc",
},
ClientSecrets = { new Secret("511536EF-F270-4058-80CA-1C89C192F69A".Sha256()) },
AllowedScopes = {
IdentityServerConstants.StandardScopes.OpenId,
IdentityServerConstants.StandardScopes.Profile,
"code_scope1"
},
//允許將token通過瀏覽器傳遞
AllowAccessTokensViaBrowser=true,
// 是否需要同意授權 （預設是false）
RequireConsent=true
}
};
}
RedirectUris: 登入成功回撥處理的客戶端地址，處理回撥返回的資料，可以有多個。
PostLogoutRedirectUris：跳轉登出到的客戶端的地址。這兩個都是配置的客戶端的地址，且是identityserver4元件裡面封裝好的地址，作用分別是登入，登出的回撥
因為是授權碼授權的方式，所以我們通過程式碼的方式來建立幾個測試使用者。
新建測試使用者檔案TestUsers.cs
public class TestUsers
{
public static List<TestUser> Users
{
get
{
var address = new
{
street_address = "One Hacker Way",
locality = "Heidelberg",
postal_code = 69118,
country = "Germany"
};
return new List<TestUser>
{
new TestUser
{
SubjectId = "1",
Username = "i3yuan",
Password = "123456",
Claims =
{
new Claim(JwtClaimTypes.Name, "i3yuan Smith"),
new Claim(JwtClaimTypes.GivenName, "i3yuan"),
new Claim(JwtClaimTypes.FamilyName, "Smith"),
new Claim(JwtClaimTypes.Email, "i3yuan@email.com"),
new Claim(JwtClaimTypes.EmailVerified, "true", ClaimValueTypes.Boolean),
new Claim(JwtClaimTypes.WebSite, "http://i3yuan.top"),
new Claim(JwtClaimTypes.Address, JsonSerializer.Serialize(address), IdentityServerConstants.ClaimValueTypes.Json)
}
}
};
}
}
}
返回一個TestUser的集合。
通過以上新增好配置和測試使用者後，我們需要將使用者註冊到IdentityServer4服務中，接下來繼續介紹。
3.1.3 註冊服務
在startup.cs中ConfigureServices方法新增如下程式碼：
public void ConfigureServices(IServiceCollection services)
{
var builder = services.AddIdentityServer()
.AddTestUsers(TestUsers.Users); //新增測試使用者
// in-memory, code config
builder.AddInMemoryIdentityResources(Config.IdentityResources);
builder.AddInMemoryApiScopes(Config.ApiScopes);
builder.AddInMemoryApiResources(Config.ApiResources);
builder.AddInMemoryClients(Config.Clients);
// not recommended for production - you need to store your key material somewhere secure
builder.AddDeveloperSigningCredential();
services.ConfigureNonBreakingSameSiteCookies();
}
3.1.4 配置管道
在startup.cs中Configure方法新增如下程式碼：
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseStaticFiles();
app.UseRouting();
app.UseCookiePolicy();
app.UseAuthentication();
app.UseAuthorization();
app.UseIdentityServer();
app.UseEndpoints(endpoints =>
{
endpoints.MapDefaultControllerRoute();
});
}
以上內容是快速搭建簡易IdentityServer專案服務的方式。
這搭建 Authorization Server 服務跟上一篇簡化模式有何不同之處呢？
- 在Config中配置客戶端(client)中定義了一個
AllowedGrantTypes的屬性，這個屬性決定了Client可以被哪種模式被訪問，GrantTypes.Code為授權碼模式。所以在本文中我們需要新增一個Client用於支援授權碼模式(Authorization Code)。
3.2 搭建API資源
實現對API資源進行保護
3.2.1 快速搭建一個API專案
3.2.2 安裝Nuget包
IdentityServer4.AccessTokenValidation 包
3.2.3 註冊服務
在startup.cs中ConfigureServices方法新增如下程式碼：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
services.AddAuthentication("Bearer")
.AddIdentityServerAuthentication(options =>
{
options.Authority = "http://localhost:5001";
options.RequireHttpsMetadata = false;
options.ApiName = "api1";
options.ApiSecret = "apipwd"; //對應ApiResources中的金鑰
});
}
AddAuthentication把Bearer配置成預設模式，將身份認證服務新增到DI中。
AddIdentityServerAuthentication把IdentityServer的access token新增到DI中，供身份認證服務使用。
3.2.4 配置管道
在startup.cs中Configure方法新增如下程式碼：
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapDefaultControllerRoute();
});
}
UseAuthentication將身份驗證中介軟體新增到管道中；
UseAuthorization 將啟動授權中介軟體新增到管道中，以便在每次呼叫主機時執行身份驗證授權功能。
3.2.5 新增API資源介面
[Route("api/[Controller]")]
[ApiController]
public class IdentityController:ControllerBase
{
[HttpGet("getUserClaims")]
[Authorize]
public IActionResult GetUserClaims()
{
return new JsonResult(from c in User.Claims select new { c.Type, c.Value });
}
}
在IdentityController 控制器中新增 [Authorize] , 在進行請求資源的時候，需進行認證授權通過後，才能進行訪問。
3.3 搭建MVC 客戶端
實現對客戶端認證授權訪問資源
3.3.1 快速搭建一個MVC專案
3.3.2 安裝Nuget包
IdentityServer4.AccessTokenValidation 包
3.3.3 註冊服務
要將對 OpenID Connect 身份認證的支援新增到MVC應用程式中。
在startup.cs中ConfigureServices方法新增如下程式碼：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
services.AddAuthorization();
services.AddAuthentication(options =>
{
options.DefaultScheme = "Cookies";
options.DefaultChallengeScheme = "oidc";
})
.AddCookie("Cookies") //使用Cookie作為驗證使用者的首選方式
.AddOpenIdConnect("oidc", options =>
{
options.Authority = "http://localhost:5001"; //授權伺服器地址
options.RequireHttpsMetadata = false; //暫時不用https
options.ClientId = "code_client";
options.ClientSecret = "511536EF-F270-4058-80CA-1C89C192F69A";
options.ResponseType = "code"; //代表Authorization Code
options.Scope.Add("code_scope1"); //新增授權資源
options.SaveTokens = true; //表示把獲取的Token存到Cookie中
options.GetClaimsFromUserInfoEndpoint = true;
});
services.ConfigureNonBreakingSameSiteCookies();
}
AddAuthentication注入新增認證授權，當需要使用者登入時，使用cookie來本地登入使用者（通過“Cookies”作為DefaultScheme），並將DefaultChallengeScheme設定為“oidc”，使用
AddCookie新增可以處理 cookie 的處理程式。在
AddOpenIdConnect用於配置執行OpenID Connect協議的處理程式和相關引數。Authority表明之前搭建的 IdentityServer 授權服務地址。然後我們通過ClientId、ClientSecret,識別這個客戶端。SaveTokens用於儲存從IdentityServer獲取的token至cookie,ture標識ASP.NETCore將會自動儲存身份認證session的access和refresh token。
3.3.4 配置管道
然後要確保認證服務執行對每個請求的驗證，加入UseAuthentication和UseAuthorization到Configure中,在startup.cs中Configure方法新增如下程式碼：
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
}
app.UseStaticFiles();
app.UseRouting();
app.UseCookiePolicy();
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
UseAuthentication將身份驗證中介軟體新增到管道中；
UseAuthorization 將啟動授權中介軟體新增到管道中，以便在每次呼叫主機時執行身份驗證授權功能。
3.3.5 新增授權
在HomeController控制器並新增[Authorize]特性到其中一個方法。在進行請求的時候，需進行認證授權通過後，才能進行訪問。
[Authorize]
public IActionResult Privacy()
{
ViewData["Message"] = "Secure page.";
return View();
}
還要修改主檢視以顯示使用者的Claim以及cookie屬性。
@using Microsoft.AspNetCore.Authentication
<h2>Claims</h2>
<dl>
@foreach (var claim in User.Claims)
{
<dt>@claim.Type</dt>
<dd>@claim.Value</dd>
}
</dl>
<h2>Properties</h2>
<dl>
@foreach (var prop in (await Context.AuthenticateAsync()).Properties.Items)
{
<dt>@prop.Key</dt>
<dd>@prop.Value</dd>
}
</dl>
訪問 Privacy 頁面，跳轉到認證服務地址，進行賬號密碼登入，Logout 用於使用者的登出操作。
3.3.6 新增資源訪問
在HomeController控制器新增對API資源訪問的介面方法。在進行請求的時候，訪問API受保護資源。
/// <summary>
/// 測試請求API資源(api1)
/// </summary>
/// <returns></returns>
public async Task<IActionResult> getApi()
{
var client = new HttpClient();
var accessToken = await HttpContext.GetTokenAsync(OpenIdConnectParameterNames.AccessToken);
if (string.IsNullOrEmpty(accessToken))
{
return Json(new { msg = "accesstoken 獲取失敗" });
}
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
var httpResponse = await client.GetAsync("http://localhost:5003/api/identity/GetUserClaims");
var result = await httpResponse.Content.ReadAsStringAsync();
if (!httpResponse.IsSuccessStatusCode)
{
return Json(new { msg = "請求 api1 失敗。", error = result });
}
return Json(new
{
msg = "成功",
data = JsonConvert.DeserializeObject(result)
});
}
測試這裡通過獲取accessToken之後，設定client請求頭的認證，訪問API資源受保護的地址，獲取資源。
3.4 效果
3.4.1 動圖
3.4.2 過程
在使用者訪問MVC程式時候，將使用者導向認證伺服器，
在客戶端向授權伺服器Authorization Endpoint進行驗證的時候，我們可以發現，向授權伺服器傳送的請求附帶的那些引數就是我們之前說到的資料(clientid,redirect_url,type等)
繼續往下看，發現在使用者給予授權完成登入之後，可以看到在登入後，授權伺服器向重定向URL地址同時帶上一個授權碼資料帶給MVC程式。
隨後MVC向授權客戶端的Token終結點傳送請求，從下圖可以看到這次請求包含了client_id，client_secret，code，grant_type和redirect_uri，向授權伺服器申請訪問令牌token, 並且在響應中可以看到授權伺服器核對了授權碼和重定向地址URI，確認無誤後，向第三方應用傳送訪問令牌(Access Token)和更新令牌(Refresh token)
完成獲取令牌後，訪問受保護資源的時候，帶上令牌請求訪問，可以成功響應獲取使用者資訊資源。
四、總結
- 本篇主要闡述以授權碼授權，編寫一個MVC客戶端，並通過客戶端以瀏覽器的形式請求IdentityServer上請求獲取訪問令牌，從而訪問受保護的API資源。
- 授權碼模式解決了簡化模式由於token攜帶在url中，安全性方面不能保證問題，而通過授權碼的模式不直接返回token，而是先返回一個授權碼，然後再根據這個授權碼去請求token，這個請求token這個過程需要放在後臺，這種方式也更為安全。適用於有後端的應用。
- 在後續會對這方面進行介紹繼續說明，資料庫持久化問題，以及如何應用在API資源伺服器中和配置在客戶端中，會進一步說明。
- 如果有不對的或不理解的地方，希望大家可以多多指正，提出問題，一起討論,不斷學習,共同進步。
- 專案地址