EZ.Redact.Lgpd.EntityFramework 2.1.0

EZ.Redact.Lgpd.EntityFramework

Extensão do Entity Framework Core para o EZ.Redact.Lgpd.Core. Redige dados pessoais automaticamente durante a leitura de entidades, sem precisar chamar ILGPDRedactService manualmente.

Basta decorar suas models com os atributos do EZ.Redact.Lgpd.Core e usar UseRedaction() na query — a redação acontece de forma transparente no momento da materialização.

Instalação

dotnet add package EZ.Redact.Lgpd.EntityFramework

Registre os serviços no DI:

using Microsoft.Extensions.DependencyInjection;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddLGPDRedaction()
                .AddEntityFrameworkRedaction(options =>
                {
                    options.UseDbContext<AppDbContext>();
                });

AddEntityFrameworkRedaction() registra o LgpdRedactionInterceptor e o configura automaticamente nos DbContexts especificados.

Exemplo rápido

using EZ.Redact.Lgpd.EntityFramework;

var clientes = await _db.Clientes
    .UseRedaction()
    .Where(c => c.Ativo)
    .ToListAsync();

Todos os dados sensíveis decorados com atributos LGPD serão redigidos automaticamente na materialização da entidade.

Configuração

LGPDRedactOptions

GuidOptions

Três formas de configurar

1. Em código (Action<LGPDRedactOptions>)

builder.Services.AddLGPDRedaction(options =>
{
    options.MaskChar = '#';
    options.Guid.PrefixHexCount = 6;
    options.HmacKey = Convert.ToBase64String(RandomNumberGenerator.GetBytes(32));
    options.HmacFor.Add(DadoPessoal.CPF);
});

2. Via IConfiguration (appsettings.json + env vars)

builder.Services.AddLGPDRedaction(builder.Configuration);

{
  "LGPD": {
    "MaskChar": "#",
    "Guid": { "PrefixHexCount": 6 },
    "HmacFor": ["CPF"],
    "HmacKeyId": 1
  }
}

A HmacKey não deve ficar no appsettings.json. Use variável de ambiente ou User Secrets:

export LGPD__HmacKey="suachavebase64aqui=="

3. Combinando ambas

builder.Services.AddLGPDRedaction(options =>
{
    options.HmacKey = Convert.ToBase64String(RandomNumberGenerator.GetBytes(32));
});
builder.Services.PostConfigure<LGPDRedactOptions>(opts =>
{
    opts.HmacFor.Add(DadoPessoal.CPF);
});

Uso

Decore suas entidades com os atributos do EZ.Redact.Lgpd.Core:

using EZ.Redact.Lgpd.Core.Attributes;

public class Cliente
{
    public int Id { get; set; }

    [NomeData]
    public string Nome { get; set; } = string.Empty;

    [CPFData]
    public string Cpf { get; set; } = string.Empty;

    [EmailData]
    public string Email { get; set; } = string.Empty;

    [TelefoneData]
    public string Telefone { get; set; } = string.Empty;

    [EnderecoData]
    public string Endereco { get; set; } = string.Empty;

    public string Observacao { get; set; } = string.Empty;
}

Consulta com redação

Use UseRedaction() na query para ativar a redação:

using EZ.Redact.Lgpd.EntityFramework;

var clientes = await _db.Clientes
    .UseRedaction()
    .Where(c => c.Ativo)
    .ToListAsync();

Consulta sem redação

Sem UseRedaction(), os dados retornam sem alteração:

var clientes = await _db.Clientes
    .Where(c => c.Ativo)
    .ToListAsync();

Saída redigida

Como funciona

1. UseRedaction() adiciona TagWith("lgpd-redact") na query, que vira um comentário no SQL gerado
2. O LgpdRedactionInterceptor implementa IDbCommandInterceptor e IMaterializationInterceptor
3. Antes da execução, o interceptor verifica se o comando SQL contém a tag -- lgpd-redact
4. Durante a materialização de cada entidade, as propriedades marcadas com atributos LGPD são inspecionadas via delegates compilados (performance em memória)
5. Para cada propriedade com valor string, o ILGPDRedactService.Redact() é chamado e o valor é substituído

A redação só ocorre em operações de leitura (SELECT). Operações de INSERT, UPDATE e DELETE nunca são afetadas.

Atributos Suportados

Os atributos são definidos pelo pacote EZ.Redact.Lgpd.Core e funcionam com qualquer entidade do EF Core.

Identificação Pessoal

Documentos Oficiais

Financeiro

Redes e Localização

Veículo

Técnico

Samples

Um projeto de exemplo na pasta samples/:

dotnet run --project samples/EZ.Redact.Lgpd.EntityFramework.Sample
curl http://localhost:5000/clientes/redacted
curl http://localhost:5000/clientes/raw

Projetos Relacionados

Licença

Distribuído sob a licença MIT.