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
详见: https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation/Areas/Admin/Views/_ViewImports.cshtml
页面元素配置#
在需要权限控制的元素上增加 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 并不会渲染输出,在客户端浏览器查看源代码也不会看到对应的代码
Reference#
- https://github.com/WeihanLi/ActivityReservation
- https://github.com/WeihanLi/AccessControlHelper
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对阿兔在线工具的支持。