Sparkdo.Security 1.0.1

Sparkdo.Security

Sparkdo 安全模块，提供身份验证、授权、加密和安全日志等核心安全功能。

功能特性

• 用户身份管理（ICurrentUser）
• 客户端身份管理（ICurrentClient）
• 声明式权限控制
• 字符串加密服务
• 安全日志记录
• 模块化安全配置

安装

<PackageReference Include="Sparkdo.Security" Version="x.x.x" />

核心组件

用户和客户端管理

• ICurrentUser: 访问当前认证用户信息
• ICurrentClient: 访问当前客户端信息

加密服务

• IStringEncryptionService: 字符串加密和解密

安全日志

• ISecurityLogManager: 安全日志管理
• ISecurityLogStore: 安全日志存储

模块配置

• SparkdoSecurityModule: 自动注册安全服务

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。

使用方法

基本身份信息访问

通过依赖注入获取当前用户信息：

public class MyService
{
    private readonly ICurrentUser _currentUser;
    
    public MyService(ICurrentUser currentUser)
    {
        _currentUser = currentUser;
    }
    
    public void DoSomething()
    {
        if (_currentUser.IsAuthenticated)
        {
            Console.WriteLine($"当前用户: {_currentUser.UserName}");
            Console.WriteLine($"用户ID: {_currentUser.Id}");
            Console.WriteLine($"用户角色: {string.Join(", ", _currentUser.Roles)}");
        }
    }
}

客户端身份信息访问

获取当前客户端信息：

public class MyService
{
    private readonly ICurrentClient _currentClient;
    
    public MyService(ICurrentClient currentClient)
    {
        _currentClient = currentClient;
    }
    
    public void DoSomething()
    {
        if (_currentClient.IsAuthenticated)
        {
            Console.WriteLine($"当前客户端ID: {_currentClient.Id}");
        }
    }
}

字符串加密

使用字符串加密服务：

public class MyService
{
    private readonly IStringEncryptionService _encryptionService;
    
    public MyService(IStringEncryptionService encryptionService)
    {
        _encryptionService = encryptionService;
    }
    
    public void EncryptData()
    {
        string plainText = "需要加密的数据";
        string encrypted = _encryptionService.Encrypt(plainText);
        string decrypted = _encryptionService.Decrypt(encrypted);
        
        Console.WriteLine($"原文: {plainText}");
        Console.WriteLine($"密文: {encrypted}");
        Console.WriteLine($"解密: {decrypted}");
    }
}

安全日志

记录安全相关操作：

public class MyService
{
    private readonly ISecurityLogManager _securityLogManager;
    
    public MyService(ISecurityLogManager securityLogManager)
    {
        _securityLogManager = securityLogManager;
    }
    
    public async Task DoSomethingAsync()
    {
        await _securityLogManager.SaveAsync(new SecurityLogInfo
        {
            Identity = "用户操作",
            Action = "数据修改",
            Message = "用户修改了重要数据",
            Parameters = "相关参数"
        });
    }
}

核心接口

ICurrentUser

当前用户信息接口，提供对当前认证用户信息的访问：

• IsAuthenticated: 是否已通过身份验证
• Id: 用户唯一标识
• UserName: 用户名
• Name: 用户姓名
• Roles: 用户角色列表
• FindClaim(): 查找特定声明
• IsInRole(): 检查用户是否在特定角色中

ICurrentClient

当前客户端信息接口，提供对当前客户端信息的访问：

• Id: 客户端唯一标识
• IsAuthenticated: 客户端是否已认证

IStringEncryptionService

字符串加密服务接口：

• Encrypt(): 加密字符串
• Decrypt(): 解密字符串

ISecurityLogManager

安全日志管理器接口：

• SaveAsync(): 保存安全日志

配置选项

SparkdoStringEncryptionOptions

字符串加密选项配置：

{
  "Sparkdo": {
    "StringEncryption": {
      "DefaultPassPhrase": "默认加密密钥",
      "DefaultSalt": "默认盐值",
      "KeySize": 256,
      "InitVectorBytes": "初始化向量"
    }
  }
}

扩展性

可以通过以下方式扩展安全功能：

1. 实现自定义的 ICurrentUser 来提供特定的用户信息访问逻辑
2. 实现自定义的 ICurrentClient 来提供特定的客户端信息访问逻辑
3. 实现自定义的 IStringEncryptionService 来提供特定的加密算法
4. 实现自定义的 ISecurityLogStore 来改变安全日志的存储方式

代码结构说明

本项目包含以下主要组件：

用户和客户端管理

• ICurrentUser 和 DefaultCurrentUser：用于访问当前认证用户的信息
• ICurrentClient 和 DefaultCurrentClient：用于访问当前客户端的信息
• CurrentUserExtensions：提供对当前用户声明信息的扩展方法

安全声明处理

• ICurrentPrincipalAccessor：用于访问当前安全主体
• ISparkdoClaimsPrincipalFactory：用于创建声明主体
• SparkdoClaimTypes：定义了系统中使用的声明类型常量
• ClaimsIdentityExtensions：提供对声明身份的扩展方法

加密服务

• IStringEncryptionService 和 DefaultStringEncryptionService：提供字符串的加密和解密功能
• SparkdoStringEncryptionOptions：配置加密服务的选项

安全日志

• ISecurityLogManager 和 DefaultSecurityLogManager：用于管理安全日志
• ISecurityLogStore 和 SimpleSecurityLogStore：用于存储安全日志
• SecurityLogInfo：安全日志信息实体
• SparkdoSecurityLogOptions：安全日志配置选项

模块配置

• SparkdoSecurityModule：安全模块的配置类，用于注册所有安全相关服务

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。