ASP.NET?Core中Cookie驗證身份用法詳解
ASP.NET Core 1.x提供了通過Cookie 中間件將用戶主體序列化為一個加密的Cookie,然后在后續(xù)請求中驗證Cookie并重新創(chuàng)建主體,并將其分配給HttpContext.User屬性。如果您要提供自己的登錄界面和用戶數(shù)據(jù)庫,可以使用作為獨立功能的Cookie中間件。
ASP.NET Core 2.x的一個主要變化是不再存在Cookie中間件。取而代之的是在Startup.cs文件中的Configure方法中的調(diào)用UseAuthentication方法會添加設置HttpContext.User屬性的 AuthenticationMiddleware 中間件。
添加配置
ASP.NET Core 1.x
按下列步驟操作:
在您的項目中安裝
Microsoft.AspNetCore.Authentication.CookiesNuGet包。此包包含Cookie中間件。在Startup.cs文件中的
Configure方法中添加下面的行,在app.UseMvc()語句之前:
app.UseCookieAuthentication(new CookieAuthenticationOptions()
{
AccessDeniedPath = "/Account/Forbidden/",
AuthenticationScheme = "MyCookieAuthenticationScheme",
AutomaticAuthenticate = true,
AutomaticChallenge = true,
LoginPath = "/Account/Unauthorized/"
});ASP.NET Core 2.x
按下列步驟操作:
如果不使用
Microsoft.AspNetCore.All元包,則在您的項目中安裝2.0版的Microsoft.AspNetCore.Authentication.CookiesNuGet包。在Startup.cs文件中的
Configure方法中調(diào)用UseAuthentication方法:
app.UseAuthentication();
- 在Startup.cs文件中的
ConfigureServices方法中調(diào)用AddAuthentication和AddCookie方法:
services.AddAuthentication("MyCookieAuthenticationScheme")
.AddCookie("MyCookieAuthenticationScheme", options => {
options.AccessDeniedPath = "/Account/Forbidden/";
options.LoginPath = "/Account/Unauthorized/";
});上面的代碼片段配置了以下部分或全部選項:
AccessDeniedPath- 當用戶嘗試訪問資源但沒有通過任何授權策略時,這是請求會重定向的相對路徑資源。AuthenticationScheme- 這是一個已知的特定Cookie認證方案的值。當有多個Cookie驗證實例,并且您想限制對一個實例的授權時,這就非常有用。AutomaticAuthenticate- 此標識僅適用于ASP.NET Core 1.x。它表示Cookie身份驗證應在每個請求上運行,并嘗試驗證和重建序列化主體。AutomaticChallenge- 此標識僅適用于ASP.NET Core 1.x。這表示當授權失敗時,1.x Cookie認證應將瀏覽器重定向到LoginPath或AccessDeniedPath。LoginPath- 當用戶嘗試訪問資源但尚未認證時,這是請求重定向的相對路徑。
其它選項包括為Cookie認證創(chuàng)建的設置選項,身份驗證的Cookie的名稱,Cookie的域和Cookie各種安全屬性。默認情況下,Cookie身份驗證為其創(chuàng)建的任何Cookie使用適當?shù)陌踩x項,例如:
- 設置HttpOnly標志以防止客戶端JavaScript中訪問Cookie
- 如果請求是通過HTTPS訪問,則將Cookie限制為HTTPS
創(chuàng)建身份認證Cookie
要創(chuàng)建一個保存用戶信息的cookie,您必須構建一個ClaimsPrincipal 保存您希望序列化到Cookie中的信息。
ASP.NET Core 1.x
await HttpContext.Authentication.SignInAsync("MyCookieAuthenticationScheme", principal);ASP.NET Core 2.x
await HttpContext.SignInAsync("MyCookieAuthenticationScheme", principal);這將創(chuàng)建一個加密的Cookie并將其添加到當前響應中。在調(diào)用SignInAsync時,必須在配置中指定的AuthenticationScheme。
順便提一下,使用的加密方式是ASP.NET Core的Data Protection系統(tǒng)。如果您在多臺機器上進行托管、負載平衡或使用Web集群,則需要配置Data Protection才能使用相同的密鑰和應用程序標識符。
Signing out(登出)
要退出當前用戶并刪除其Cookie,請在控制器中調(diào)用以下方法:
ASP.NET Core 1.x
await HttpContext.Authentication.SignOutAsync("MyCookieAuthenticationScheme");ASP.NET Core 2.x
await HttpContext.SignOutAsync("MyCookieAuthenticationScheme");服務端變化反饋
警告: 一旦創(chuàng)建了認證的Cookie,它將成為唯一的身份來源。即使您在服務系統(tǒng)中禁用用戶,Cookie身份驗證也無法了解此信息,只要Cookie有效,用戶仍可登錄。
Cookie認證在其選項中提供了一系列事件。ValidateAsync()事件可用于攔截和重寫Cookie身份驗證。
可以考慮在后端用戶數(shù)據(jù)庫中增加LastChanged列。為了在數(shù)據(jù)庫更改時使Cookie無效,您應該首先在創(chuàng)建Cookie時添加一個LastChanged包含當前值的聲明。數(shù)據(jù)庫更改時,更新LastChanged例的值。
要重寫ValidateAsync()事件的實現(xiàn),您必須編寫一個具有以下簽名的方法:
Task ValidateAsync(CookieValidatePrincipalContext context);
ASP.NET Core Identity 在SecurityStampValidator實現(xiàn)了這一邏輯,鏈接地址。示例如下所示:
ASP.NET Core 1.x
public static class LastChangedValidator
{
public static async Task ValidateAsync(CookieValidatePrincipalContext context)
{
// Pull database from registered DI services.
var userRepository = context.HttpContext.RequestServices.GetRequiredService<IUserRepository>();
var userPrincipal = context.Principal;
// Look for the last changed claim.
string lastChanged;
lastChanged = (from c in userPrincipal.Claims
where c.Type == "LastUpdated"
select c.Value).FirstOrDefault();
if (string.IsNullOrEmpty(lastChanged) ||
!userRepository.ValidateLastChanged(userPrincipal, lastChanged))
{
context.RejectPrincipal();
await context.HttpContext.Authentication.SignOutAsync("MyCookieAuthenticationScheme");
}
}
}然后,在Startup.cs文件中的Configure方法中將Cokie認證配置進行重寫:
app.UseCookieAuthentication(new CookieAuthenticationOptions
{
Events = new CookieAuthenticationEvents
{
OnValidatePrincipal = LastChangedValidator.ValidateAsync
}
});ASP.NET Core 2.x
public static class LastChangedValidator
{
public static async Task ValidateAsync(CookieValidatePrincipalContext context)
{
// Pull database from registered DI services.
var userRepository = context.HttpContext.RequestServices.GetRequiredService<IUserRepository>();
var userPrincipal = context.Principal;
// Look for the last changed claim.
string lastChanged;
lastChanged = (from c in userPrincipal.Claims
where c.Type == "LastUpdated"
select c.Value).FirstOrDefault();
if (string.IsNullOrEmpty(lastChanged) ||
!userRepository.ValidateLastChanged(userPrincipal, lastChanged))
{
context.RejectPrincipal();
await context.HttpContext.SignOutAsync("MyCookieAuthenticationScheme");
}
}
}然后,將在Startup.cs的ConfigureServices方法中將Cookie服務注冊進行配置:
services.AddAuthentication("MyCookieAuthenticationScheme")
.AddCookie(options =>
{
options.Events = new CookieAuthenticationEvents
{
OnValidatePrincipal = LastChangedValidator.ValidateAsync
};
});如果要非破壞性地更新用戶主體,可以調(diào)用context.ReplacePrincipal(),并將context.ShouldRenew屬性設置為true。
Cookie設置選項
CookieAuthenticationOptions類提供了各種配置選項,在創(chuàng)建時調(diào)整Cookie的配置。
ASP.NET Core 1.x
ClaimsIssuer是由中間件創(chuàng)建的任何聲明時使用的Issuer屬性。CookieDomain是提供Cookie的域名。默認情況下,這是發(fā)送請求的主機名。瀏覽器僅將Cookie提供給匹配的主機名。您可能希望對此進行調(diào)整,以便您的域中的任何主機都可以使用Cookie。例如,將Cookie域名設置為.contoso.com,可以使用Cookie的域名有contoso.com、www.contoso.com、staging.www.contoso.com等。CookieHttpOnly是一個標識,指定Cookie是否只能由服務器訪問。默認為true。如果您的應用程序具有Cross-Site Scripting(XSS)的問題,更改此值可能會導致Cookie被盜用。CookiePath可用于隔離在相同主機名上運行的應用程序。如果你有一個應用程序在/app1中運行,并希望限制發(fā)送的Cookie只發(fā)送到該應用程序,那么您應該將CookiePath屬性設置為/app1。通過這樣做,Cookie只適用于對/app1或其下任何內(nèi)容的請求。CookieSecure是一個標識,表示創(chuàng)建的Cookie是否應該被限制為HTTPS,HTTP或HTTPS,或與請求相同的協(xié)議。默認為SameAsRequest。ExpireTimeSpan是TimeSpan類型,在此時間段之后Cookie將過期。將當前日期加上此時間段為創(chuàng)建Cookie的到期日期。SlidingExpiration是一個標識,指示當超過一半的ExpireTimeSpan間隔時,Cookie到期日期是否復位。新的到期日是當前時間加上ExpireTimespan。調(diào)用SignInAsync時,可以使用AuthenticationProperties類設置絕對到期時間。絕對到期時間可以通過限制認證Cookie有效的時間來提高應用程序的安全性。
在Startup.cs文件中的Configure方法中使用CookieAuthenticationOptions的例子如下:
app.UseCookieAuthentication(new CookieAuthenticationOptions
{
CookieName = "AuthCookie",
CookieDomain = "contoso.com",
CookiePath = "/",
CookieHttpOnly = true,
CookieSecure = CookieSecurePolicy.Always
});ASP.NET Core 2.x
ASP.NET Core 2.x 統(tǒng)一了用于配置Cookie的API。1.x API已被標記為過時,并且在CookieAuthenticationOptions類中引入了一種類型為CookieBuilder新的Cookie屬性。建議您遷移到2.x API。
ClaimsIssuer是由Cookie認證創(chuàng)建的任何聲明時使用的Issuer屬性。CookieBuilder.Domain是提供Cookie的域名。默認情況下,這是發(fā)送請求的主機名。瀏覽器僅將Cookie提供給匹配的主機名。您可能希望對此進行調(diào)整,以便您的域中的任何主機都可以使用Cookie。例如,將Cookie域名設置為.contoso.com,可以使用Cookie的域名有contoso.com、www.contoso.com、staging.www.contoso.com等CookieBuilder.HttpOnly是一個標識,指定Cookie是否只能由服務器訪問。默認為true。如果您的應用程序具有Cross-Site Scripting(XSS)的問題,更改此值可能會導致Cookie被盜用。CookieBuilder.Path可用于隔離在相同主機名上運行的應用程序。如果你有一個應用程序在/app1中運行,并希望限制發(fā)送的Cookie只發(fā)送到該應用程序,那么您應該將CookiePath屬性設置為/app1。通過這樣做,Cookie只適用于對/app1或其下任何內(nèi)容的請求。CookieBuilder.SameSite表示瀏覽器是否允許Cookie被附加到同一站點或跨站點的請求。默認為SameSiteMode.Lax。CookieBuilder.SecurePolicy是一個標識,表示創(chuàng)建的Cookie是否應該被限制為HTTPS,HTTP或HTTPS,或與請求相同的協(xié)議。默認為SameAsRequest。ExpireTimeSpan是TimeSpan類型,在此時間段之后Cookie將過期。將當前日期加上此時間段為創(chuàng)建Cookie的到期日期。SlidingExpiration是一個標識,指示當超過一半的ExpireTimeSpan間隔時,Cookie到期日期是否復位。新的到期日是當前時間加上ExpireTimespan。調(diào)用SignInAsync時,可以使用AuthenticationProperties類設置絕對到期時間。絕對到期時間可以通過限制認證Cookie有效的時間來提高應用程序的安全性。
在Startup.cs的ConfigureServices方法中使用CookieAuthenticationOptions的例子如下:
services.AddAuthentication()
.AddCookie(options =>
{
options.Cookie.Name = "AuthCookie";
options.Cookie.Domain = "contoso.com";
options.Cookie.Path = "/";
options.Cookie.HttpOnly = true;
options.Cookie.SameSite = SameSiteMode.Lax;
options.Cookie.SecurePolicy = CookieSecurePolicy.Always;
});持久Cookie
您可能希望Cookie在瀏覽器會話中持續(xù)存在,并希望設置身份和Cookie傳輸?shù)慕^對過期時間。這種持久性應該只能是用戶顯示同意,在登錄時的“記住我”復選框或類似的機制啟用。您可以通過在創(chuàng)建身份認證Cookie時調(diào)用的SignInAsync方法中使用AuthenticationProperties參數(shù)來執(zhí)行這些操作。例如:
ASP.NET Core 1.x
await HttpContext.Authentication.SignInAsync(
"MyCookieAuthenticationScheme",
principal,
new AuthenticationProperties
{
IsPersistent = true
});上述代碼片段中使用的AuthenticationProperties類,位于Microsoft.AspNetCore.Http.Authentication命名空間中。
ASP.NET Core 2.x
await HttpContext.SignInAsync(
"MyCookieAuthenticationScheme",
principal,
new AuthenticationProperties
{
IsPersistent = true
});上述代碼片段中使用的AuthenticationProperties類,位于Microsoft.AspNetCore.Authentication命名空間中。
上面的代碼段創(chuàng)建一個身份和相應的Cookie,直到瀏覽器關閉。以前通過Cookie設置選項配置的任何滑動過期設置仍然有效。如果Cookie在瀏覽器關閉時過期,瀏覽器會在重新啟動后清除它。如果Cookie在瀏覽器關閉時過期,瀏覽器會在重新啟動后清除它。
絕對到期時間
ASP.NET Core 1.x
await HttpContext.Authentication.SignInAsync(
"MyCookieAuthenticationScheme",
principal,
new AuthenticationProperties
{
ExpiresUtc = DateTime.UtcNow.AddMinutes(20)
});ASP.NET Core 2.x
await HttpContext.SignInAsync(
"MyCookieAuthenticationScheme",
principal,
new AuthenticationProperties
{
ExpiresUtc = DateTime.UtcNow.AddMinutes(20)
});上述代碼段創(chuàng)建一個持續(xù)20分鐘的身份和相應的cookie。這將忽略以前通過Cookie設置選項配置的任何滑動過期設置。
ExpiresUtc和IsPersistent屬性是互斥的。
到此這篇關于ASP.NET Core中Cookie驗證身份用法詳解的文章就介紹到這了。希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
- ASP.NET?Core?模型驗證消息的本地化新姿勢詳解
- ASP.NET?Core?6.0?基于模型驗證的數(shù)據(jù)驗證功能
- asp.net core3.1cookie和jwt混合認證授權實現(xiàn)多種身份驗證方案
- asp.net core配合vue實現(xiàn)后端驗證碼邏輯
- [Asp.Net Core]用Blazor Server Side實現(xiàn)圖片驗證碼
- ASP.NET Core實現(xiàn)自定義WebApi模型驗證詳解
- asp.net core系列之模型綁定和驗證方法
- ASP.NET Core WebApi中使用FluentValidation驗證數(shù)據(jù)模型的方法
相關文章
Asp.NetCore1.1版本去掉project.json后如何打包生成跨平臺包
這篇文章主要為大家詳細介紹了Asp.NetCore1.1版本去掉project.json后如何打包生成跨平臺包 ,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-06-06
ASP.NET Core奇淫技巧之動態(tài)WebApi的實現(xiàn)
這篇文章主要介紹了ASP.NET Core奇淫技巧之動態(tài)WebApi的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-08-08
SignalR Self Host+MVC等多端消息推送服務(三)
這篇文章主要為大家詳細介紹了SignalR Self Host+MVC等多端消息推送服務的第三篇,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-06-06
ASP.NET Core自動生成小寫破折號路由的實現(xiàn)方法
這篇文章主要介紹了ASP.NET Core自動生成小寫破折號路由的實現(xiàn)方法,幫助大家更好的理解和學習使用ASP.NET Core,感興趣的朋友可以了解下2021-04-04

