asp.net core 使用 AccessControlHelper 控制訪問許可權
- 2019 年 10 月 20 日
- 筆記
asp.net core 使用 AccessControlHelper 控制訪問許可權
Intro
由於項目需要，需要在基於 asp.net mvc 的 Web 項目框架中做許可權的控制，於是才有了這個許可權控制組件，最初只是支援 netframework，後來 dotnetcore 2.0 發布了之後添加了對 asp.net core 的支援，在 dotnetcore 3.0 發布之後也增加了對 asp.net core 3.0 的支援(1.9.0及之後版本)，目前對於 asp.net core 支援的更多一些，asp.net core 可以使用 TagHelper 來控制頁面上元素的許可權訪問，也可以通過 Policy 來控制許可權訪問，同時支援通過中間件也可以實現對靜態資源的訪問。
安裝 AccessControlHelper nuget 包
安裝 nuget 包 WeihanLi.AspNetMvc.AccessControlHelper
dotnet add package WeihanLi.AspNetMvc.AccessControlHelper實現自己的訪問策略
資源訪問策略/API訪問策略
以下程式碼定義了一個簡單的訪問策略，需要登錄且擁有 Admin 角色，可以根據自己需要調整優化
public class AdminPermissionRequireStrategy : IResourceAccessStrategy { private readonly IHttpContextAccessor _accessor; public AdminPermissionRequireStrategy(IHttpContextAccessor accessor) { _accessor = accessor; } public bool IsCanAccess(string accessKey) { var user = _accessor.HttpContext.User; return user.Identity.IsAuthenticated && user.IsInRole("Admin"); } public IActionResult DisallowedCommonResult => new ContentResult { Content = "No Permission", ContentType = "text/plain", StatusCode = 403 }; public IActionResult DisallowedAjaxResult => new JsonResult(new JsonResultModel { ErrorMsg = "No Permission", Status = JsonResultStatus.NoPermission }); }頁面元素訪問策略
定義頁面元素/控制項訪問策略：
public class AdminOnlyControlAccessStrategy : IControlAccessStrategy { private readonly IHttpContextAccessor _accessor; public AdminOnlyControlAccessStrategy(IHttpContextAccessor httpContextAccessor) => _accessor = httpContextAccessor; public bool IsControlCanAccess(string accessKey) { if ("Never".Equals(accessKey, System.StringComparison.OrdinalIgnoreCase)) { return false; } var user = _accessor.HttpContext.User; return user.Identity.IsAuthenticated && user.IsInRole("Admin"); } }服務註冊配置
在 Startup 里註冊服務：
services.AddAccessControlHelper() .AddResourceAccessStrategy<Filters.AdminPermissionRequireStrategy>() .AddControlAccessStrategy<Filters.AdminOnlyControlAccessStrategy>() ;如果你只是 web api ，不涉及到頁面元素的許可權控制可以只註冊 ResourceAccessStrategy
services.AddAccessControlHelper() .AddResourceAccessStrategy<Filters.AdminPermissionRequireStrategy>();默認訪問策略的生命周期是單例的，如果需要註冊為Scoped，可以指定默認的生命周期
services.AddAccessControlHelper() .AddResourceAccessStrategy<Filters.AdminPermissionRequireStrategy>(ServiceLifetime.Scoped);API/資源的許可權控制
對於 asp.net core 應用推薦使用 Policy 來控制許可權的訪問，可以在需要許可權控制的 Action 或者 Controller 上設置 [Authorize("AccessControl")] 或者 [Authorize(AccessControlHelperConstants.PolicyName)]
[Authorize(AccessControlHelperConstants.PolicyName)] public class SystemSettingsController : AdminBaseController { // ... }[Authorize(AccessControlHelperConstants.PolicyName)] public ActionResult UserList() { return View(); }頁面元素的許可權控制
引用 TagHelper
在 Views 目錄下的 _ViewImports.cshtml 文件中導入 AccessControlHelper 的 TagHelper
@using ActivityReservation @using WeihanLi.AspNetMvc.AccessControlHelper @using WeihanLi.AspNetMvc.MvcSimplePager @addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers @addTagHelper *, WeihanLi.AspNetMvc.AccessControlHelper頁面元素配置
在需要許可權控制的元素上增加 asp-access 的 attribute 就可以了，如果需要 access-key 通過 asp-access-key 來配置
<ul class="list-group" asp-access asp-access-key="AdminOnly"> <li role="separator" class="list-unstyled"> <br /> </li> <li class="list-group-item">@Html.ActionLink("用戶管理", "UserList", "Account")</li> <li class="list-group-item">@Html.ActionLink("操作日誌查看", "Index", "OperationLog")</li> <li class="list-group-item">@Html.ActionLink("系統設置管理", "Index", "SystemSettings")</li> <li class="list-group-item"> @Html.ActionLink("微信設置管理", "Index", new { controller = "Config", area = "Wechat" }) </li> </ul>這樣就可以了，有許可權訪問的時候才會正常渲染，沒有許可權訪問的時候，這一段 ul 並不會渲染輸出，在客戶端瀏覽器查看源程式碼也不會看到對應的程式碼
