EZ.Redact.Lgpd.MongoDb 2.1.1

EZ.Redact.Lgpd.MongoDb

Extensão MongoDB para o EZ.Redact.Lgpd.Core. Redige dados pessoais automaticamente durante a leitura de documentos no MongoDB, sem precisar chamar ILGPDRedactService manualmente.

Basta decorar suas models com os atributos do EZ.Redact.Lgpd.Core e usar .UseRedaction() nas queries — a redação acontece de forma transparente.

Instalação

dotnet add package EZ.Redact.Lgpd.MongoDb

Registre os serviços no DI:

using Microsoft.Extensions.DependencyInjection;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddLGPDRedaction()
                .AddMongoDbRedaction();

AddMongoDbRedaction() registra o suporte a redação em queries MongoDB.

Exemplo rápido

using EZ.Redact.Lgpd.MongoDb;

var collection = db.GetCollection<Cliente>("clientes");
var comRedacao = await collection
    .UseRedaction()
    .Find(c => c.Ativo)
    .ToListAsync();

Todos os dados sensíveis decorados com atributos LGPD serão redigidos automaticamente nos documentos retornados.

Configuração

Refere-se às opções do pacote EZ.Redact.Lgpd.Core:

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": "#",
    "HmacFor": ["CPF"],
    "HmacKeyId": 1
  }
}

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

Adicione .UseRedaction() à sua collection para que os documentos retornados tenham os dados sensíveis redigidos automaticamente:

using EZ.Redact.Lgpd.Core;
using EZ.Redact.Lgpd.Core.Attributes;
using EZ.Redact.Lgpd.MongoDb;
using MongoDB.Driver;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddLGPDRedaction()
    .AddMongoDbRedaction();

builder.Services.AddSingleton<IMongoClient>(
    _ => new MongoClient("mongodb://localhost:27017"));
builder.Services.AddSingleton(sp =>
{
    var client = sp.GetRequiredService<IMongoClient>();
    return client.GetDatabase("exemplo");
});

var app = builder.Build();

app.MapGet("/clientes", async (IMongoDatabase db) =>
{
    var collection = db.GetCollection<Cliente>("clientes");

    var comRedacao = await collection
        .UseRedaction()
        .Find(c => c.Ativo)
        .ToListAsync();

    var semRedacao = await collection
        .Find(c => c.Ativo)
        .ToListAsync();

    return Results.Ok(new { comRedacao, semRedacao });
});

app.Run();

Sem redação

Basta omitir .UseRedaction() na mesma collection — a query executa normalmente sem redação:

var clientes = await collection
    .Find(c => c.Ativo)
    .ToListAsync();

Modelo com atributos

public class Cliente
{
    [CPFData]
    public string? Cpf { get; set; }

    [NomeData]
    public string? Nome { get; set; }

    [EmailData]
    public string? Email { get; set; }

    public bool Ativo { get; set; }
}

Resultado redigido

{
  "comRedacao": [
    {
      "cpf": "123.***.***-01",
      "nome": "J*** S****",
      "email": "j*****@gmail.com",
      "ativo": true
    }
  ],
  "semRedacao": [
    {
      "cpf": "123.456.789-01",
      "nome": "João Silva",
      "email": "joao.silva@gmail.com",
      "ativo": true
    }
  ]
}

Como funciona

1. UseRedaction() envolve IMongoCollection<T> em um wrapper que intercepta as operações de leitura
2. Quando Find(), FindAsync() ou FindSync() é chamado, os cursores retornados são encapsulados
3. Ao materializar cada documento, o RedactionHelper inspeciona as propriedades via reflection com cache (ConcurrentDictionary)
4. Propriedades com DataClassificationAttribute de taxonomia "LGPD" são redigidas através do ILGPDRedactService
5. O serviço de redação respeita as configurações de environment definidas em AddLGPDRedaction() — quando a redação está desabilitada, os dados retornam inalterados

Atributos Suportados

Os atributos são definidos pelo pacote EZ.Redact.Lgpd.Core e funcionam com qualquer provedor de dados.

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.MongoDb.SampleApi
curl http://localhost:5000/clientes | jq

Projetos Relacionados

Licença

Distribuído sob a licença MIT.