AuthPermissions.AspNetCore 开源项目教程

1. 项目介绍

1.1 项目概述

AuthPermissions.AspNetCore（简称 AuthP）是一个为 ASP.NET Core 应用程序提供额外授权功能的库。它主要提供以下三大功能：

• 改进的角色授权系统：管理员用户可以动态更改角色可访问的功能，无需编辑和重新部署应用程序。
• 多租户数据库系统：支持单层或多层（层次结构）租户。
• JWT 刷新令牌功能：增强使用 JWT 令牌的安全性。

1.2 项目特点

• 开源：基于 MIT 许可证，永久开源。
• 灵活性：支持多种 ASP.NET Core 认证提供者，如 Individual Accounts 和 Azure Active Directory。
• 多语言支持：提供本地化支持，可根据用户选择显示不同语言。

2. 项目快速启动

2.1 环境准备

确保你已经安装了以下工具和框架：

• .NET 8 SDK
• Visual Studio 2022 或更高版本（可选）

2.2 安装依赖

通过 NuGet 安装 AuthPermissions.AspNetCore 包：

dotnet add package AuthPermissions.AspNetCore --version 8.0.0

2.3 配置 Startup.cs

在 Startup.cs 文件中配置 AuthPermissions：

public void ConfigureServices(IServiceCollection services)
{
    services.RegisterAuthPermissions<YourPermissions>(options =>
    {
        options.TenantType = TenantTypes.SingleLevel;
        options.LinkToTenantType = LinkToTenantTypes.OnlyAppUsers;
        options.PathToFolderToLock = _env.WebRootPath;
    })
    .UsingEfCoreSqlServer(Configuration.GetConnectionString("DefaultConnection"))
    .IndividualAccountsAuthentication()
    .RegisterAuthenticationProviderReader<SyncIndividualAccountUsers>()
    .IndividualAccountsAddSuperUser()
    .SetupAspNetCoreAndDatabase();
}

2.4 配置 appsettings.json

在 appsettings.json 中添加超级管理员配置：

{
  "SuperAdmin": {
    "Email": "[e-mail]",
    "Password": "[e-mail]"
  }
}

3. 应用案例和最佳实践

3.1 多租户应用

AuthPermissions.AspNetCore 支持多租户应用，可以轻松管理多个租户的数据和权限。以下是一个简单的多租户配置示例：

services.RegisterAuthPermissions<YourPermissions>(options =>
{
    options.TenantType = TenantTypes.SingleLevel;
    options.LinkToTenantType = LinkToTenantTypes.OnlyAppUsers;
})
.UsingEfCoreSqlServer(Configuration.GetConnectionString("DefaultConnection"))
.SetupMultiTenantSharding();

3.2 JWT 令牌刷新

通过配置 JWT 刷新令牌功能，可以提高应用程序的安全性：

services.RegisterAuthPermissions<YourPermissions>(options =>
{
    options.JwtRefreshTokenFeature = true;
})
.UsingEfCoreSqlServer(Configuration.GetConnectionString("DefaultConnection"));

4. 典型生态项目

4.1 集成 Entity Framework Core

AuthPermissions.AspNetCore 与 Entity Framework Core 无缝集成，支持 SQL Server、PostgreSQL 和 SQLite 等多种数据库。

4.2 使用 Azure Active Directory

通过配置 Azure AD 认证，可以轻松集成 Azure 的认证服务：

services.RegisterAuthPermissions<YourPermissions>(options =>
{
    options.TenantType = TenantTypes.SingleLevel;
})
.UsingEfCoreSqlServer(Configuration.GetConnectionString("DefaultConnection"))
.AzureAdAuthentication();

4.3 本地化支持

通过配置本地化资源，可以支持多语言应用：

services.RegisterAuthPermissions<YourPermissions>(options =>
{
    options.TenantType = TenantTypes.SingleLevel;
})
.UsingEfCoreSqlServer(Configuration.GetConnectionString("DefaultConnection"))
.SetupAuthPLocalization<YourResource>(new[] { "en", "fr" });

通过以上步骤，你可以快速上手并使用 AuthPermissions.AspNetCore 构建安全、灵活的 ASP.NET Core 应用程序。