快捷導(dǎo)航

asp.net core利用AccessControlHelper實(shí)現(xiàn)控制訪問權(quán)限

更新時(shí)間：2019年10月21日 08:29:41 作者：WeihanLi

這篇文章主要給大家介紹了關(guān)于asp.net core利用AccessControlHelper實(shí)現(xiàn)控制訪問權(quán)限的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者使用asp.net core具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧

Intro#

由于項(xiàng)目需要，需要在基于 asp.net mvc 的 Web 項(xiàng)目框架中做權(quán)限的控制，于是才有了這個(gè)權(quán)限控制組件，最初只是支持 netframework，后來 dotnetcore 2.0 發(fā)布了之后添加了對(duì) asp.net core 的支持，在 dotnetcore 3.0 發(fā)布之后也增加了對(duì) asp.net core 3.0 的支持(1.9.0及之后版本)，目前對(duì)于 asp.net core 支持的更多一些，asp.net core 可以使用 TagHelper 來控制頁(yè)面上元素的權(quán)限訪問，也可以通過 Policy 來控制權(quán)限訪問，同時(shí)支持通過中間件也可以實(shí)現(xiàn)對(duì)靜態(tài)資源的訪問。

安裝 AccessControlHelper nuget 包#

安裝 nuget 包 WeihanLi.AspNetMvc.AccessControlHelper

dotnet add package WeihanLi.AspNetMvc.AccessControlHelper

實(shí)現(xiàn)自己的訪問策略#

資源訪問策略/API訪問策略#

以下代碼定義了一個(gè)簡(jiǎn)單的訪問策略，需要登錄且擁有 Admin 角色，可以根據(jù)自己需要調(diào)整優(yōu)化

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
  });
}

頁(yè)面元素訪問策略#

定義頁(yè)面元素/控件訪問策略：

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");
  }
}

服務(wù)注冊(cè)配置#

在 Startup 里注冊(cè)服務(wù)：

services.AddAccessControlHelper()
  .AddResourceAccessStrategy<Filters.AdminPermissionRequireStrategy>()
  .AddControlAccessStrategy<Filters.AdminOnlyControlAccessStrategy>()
  ;

如果你只是 web api ，不涉及到頁(yè)面元素的權(quán)限控制可以只注冊(cè) ResourceAccessStrategy

services.AddAccessControlHelper()
.AddResourceAccessStrategy<Filters.AdminPermissionRequireStrategy>();

默認(rèn)訪問策略的生命周期是單例的，如果需要注冊(cè)為Scoped，可以指定默認(rèn)的生命周期

services.AddAccessControlHelper()
.AddResourceAccessStrategy<Filters.AdminPermissionRequireStrategy>(ServiceLifetime.Scoped);

API/資源的權(quán)限控制#

對(duì)于 asp.net core 應(yīng)用推薦使用 Policy 來控制權(quán)限的訪問，可以在需要權(quán)限控制的 Action 或者 Controller 上設(shè)置 [Authorize("AccessControl")] 或者 [Authorize(AccessControlHelperConstants.PolicyName)]

[Authorize(AccessControlHelperConstants.PolicyName)]
public class SystemSettingsController : AdminBaseController
{
  // ...
}

[Authorize(AccessControlHelperConstants.PolicyName)]
public ActionResult UserList()
{
  return View();
}

頁(yè)面元素的權(quán)限控制#

引用 TagHelper#

在 Views 目錄下的 _ViewImports.cshtml 文件中導(dǎo)入 AccessControlHelper 的 TagHelper

@using ActivityReservation
@using WeihanLi.AspNetMvc.AccessControlHelper
@using WeihanLi.AspNetMvc.MvcSimplePager

@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
@addTagHelper *, WeihanLi.AspNetMvc.AccessControlHelper

詳見: https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation/Areas/Admin/Views/_ViewImports.cshtml

頁(yè)面元素配置#

在需要權(quán)限控制的元素上增加 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("系統(tǒng)設(shè)置管理", "Index", "SystemSettings")</li>
  <li class="list-group-item">
    @Html.ActionLink("微信設(shè)置管理", "Index", new {
    controller = "Config",
    area = "Wechat"
  })
  </li>
</ul>

這樣就可以了，有權(quán)限訪問的時(shí)候才會(huì)正常渲染，沒有權(quán)限訪問的時(shí)候，這一段 ul 并不會(huì)渲染輸出，在客戶端瀏覽器查看源代碼也不會(huì)看到對(duì)應(yīng)的代碼

Reference#