FreeSql实现字段加解密的最佳实践

背景介绍

在现代应用开发中，数据安全越来越受到重视。特别是对于敏感信息如用户姓名、身份证号、手机号等字段，通常需要在数据库层面进行加密存储。FreeSql作为一款功能强大的ORM框架，提供了多种机制来实现字段级别的加解密功能。

常见加解密场景

在实际开发中，我们通常需要处理以下几种加解密场景：

1. 插入数据时加密：当数据被写入数据库前，对指定字段进行加密
2. 更新数据时加密：当修改数据时，对变更的敏感字段重新加密
3. 查询数据时解密：从数据库读取数据后，对加密字段进行解密
4. 查询条件加密：在WHERE条件中使用加密字段时，需要先对条件值加密

FreeSql的加解密实现方案

FreeSql提供了多种AOP（面向切面编程）机制，可以优雅地实现字段加解密功能。

1. 基本加解密配置

首先，我们可以定义一个自定义属性来标记需要加密的字段：

[AttributeUsage(AttributeTargets.Property)]
public class SecretAttribute : Attribute
{
}

然后，在实体类中使用这个属性标记需要加密的字段：

public class Test
{
    public int Id { get; set; }
    
    [Secret]
    public string Name { get; set; }
}

2. 插入和更新时的加密处理

通过AuditValue事件可以实现插入和更新时的自动加密：

_fsql.Aop.AuditValue += (s, e) =>
{
    if (e.Property.GetCustomAttribute<SecretAttribute>() != null && e.Value != null)
    {
        if (e.AuditValueType == AuditValueType.Insert || 
            e.AuditValueType == AuditValueType.Update)
        {
            e.Value = AesEncryption.Encrypt(e.Value.ToString(), "0123456789ABCDEF");
        }
    }
};

3. 查询结果解密处理

通过AuditDataReader事件可以实现查询结果的自动解密：

_fsql.Aop.AuditDataReader += (s, e) =>
{
    if (e.Property.GetCustomAttribute<SecretAttribute>() != null)
    {
        e.Value = AesEncryption.Decrypt(e.Value.ToString(), "0123456789ABCDEF");
    }
};

4. 查询条件加密处理

对于查询条件中的加密字段，FreeSql推荐使用TypeHandler来实现自动加密。首先定义一个自定义类型：

public class EncryptedString
{
    public string Value { get; set; }
}

然后为该类型实现TypeHandler：

fsql.CodeFirst.SetTypeHandler<EncryptedString>(
    obj => obj?.Value == null ? null : AesEncryption.Encrypt(obj.Value, "0123456789ABCDEF"),
    dbValue => new EncryptedString { Value = AesEncryption.Decrypt(dbValue?.ToString(), "0123456789ABCDEF") }
);

在实体类中使用这个自定义类型：

public class Test
{
    public int Id { get; set; }
    
    public EncryptedString Name { get; set; }
}

这样，在查询时FreeSql会自动处理加密字段的条件值：

var result = fsql.Select<Test>()
    .Where(t => t.Name == new EncryptedString { Value = "张三" })
    .ToList();

最佳实践建议

1. 性能考虑：加解密操作会带来一定的性能开销，建议只对真正敏感的字段进行加密
2. 密钥管理：加密密钥应该妥善保管，可以考虑使用专门的密钥管理系统
3. 加密算法：选择安全可靠的加密算法，如AES-256
4. 测试覆盖：确保加解密逻辑在各种场景下都能正常工作，包括null值处理等边界情况
5. 日志记录：在开发环境可以添加适当的日志，帮助调试加解密逻辑

通过以上方案，我们可以实现FreeSql项目中字段级别的透明加解密，既保证了数据安全，又保持了代码的简洁性。