EZ.Redact.Lgpd.Json 2.1.0

EZ.Redact.Lgpd.Json

Extensão de serialização para o EZ.Redact.Lgpd.Core. Redige dados pessoais automaticamente durante a serialização JSON com System.Text.Json e Newtonsoft.Json, sem precisar chamar ILGPDRedactService manualmente.

Basta decorar suas models com os atributos do EZ.Redact.Lgpd.Core e configurar o serializador — a redação acontece de forma transparente.

Instalação

dotnet add package EZ.Redact.Lgpd.Json

Registre os servicos no DI com AddLGPDRedaction():

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddLGPDRedaction();
builder.Logging.EnableRedaction(options => options.ApplyDiscriminator = false);

Configuração

Registre o serviço de redação antes de configurar a serialização:

using EZ.Redact.Lgpd.Core;
using EZ.Redact.Lgpd.Json;

builder.Services.AddLGPDRedaction()
                .AddSerialization();

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 com System.Text.Json

Adicione o modificador ao DefaultJsonTypeInfoResolver:

using EZ.Redact.Lgpd.Json.SystemTextJson;
using System.Text.Json;
using System.Text.Json.Serialization.Metadata;

var options = new JsonSerializerOptions
{
    TypeInfoResolver = new DefaultJsonTypeInfoResolver()
        .WithAddedModifier(LGPDRedactModifier.Create(redactService))
};

Em ASP.NET Core, configure os JsonOptions globais com IConfigureOptions<>:

using EZ.Redact.Lgpd.Json.SystemTextJson;
using Microsoft.AspNetCore.Http.Json;
using Microsoft.Extensions.Options;

public sealed class LGPDRedactJsonOptionsSetup : IConfigureOptions<JsonOptions>
{
    private readonly ILGPDRedactService _redactService;

    public LGPDRedactJsonOptionsSetup(ILGPDRedactService redactService)
        => _redactService = redactService;

    public void Configure(JsonOptions options)
    {
        options.SerializerOptions.TypeInfoResolver = new DefaultJsonTypeInfoResolver()
            .WithAddedModifier(LGPDRedactModifier.Create(_redactService));
    }
}

// Program.cs
builder.Services.AddTransient<IConfigureOptions<JsonOptions>, LGPDRedactJsonOptionsSetup>();

Uso com Newtonsoft.Json

Registre o LGPDRedactContractResolver — já registrado como singleton pelo AddSerialization():

using EZ.Redact.Lgpd.Json.NewtonsoftJson;

var settings = new JsonSerializerSettings
{
    ContractResolver = serviceProvider.GetRequiredService<LGPDRedactContractResolver>()
};

Em ASP.NET Core com AddNewtonsoftJson(), use IConfigureOptions<>:

using EZ.Redact.Lgpd.Json.NewtonsoftJson;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;

public sealed class LGPDRedactNewtonsoftOptionsSetup : IConfigureOptions<MvcNewtonsoftJsonOptions>
{
    private readonly LGPDRedactContractResolver _resolver;

    public LGPDRedactNewtonsoftOptionsSetup(LGPDRedactContractResolver resolver)
        => _resolver = resolver;

    public void Configure(MvcNewtonsoftJsonOptions options)
    {
        options.SerializerSettings.ContractResolver = _resolver;
    }
}

// Program.cs
builder.Services.AddTransient<IConfigureOptions<MvcNewtonsoftJsonOptions>, LGPDRedactNewtonsoftOptionsSetup>();

Atributos Suportados

Identificação Pessoal

Documentos Oficiais

Financeiro

Redes e Localização

Veículo

Técnico

Samples

Dois projetos de exemplo na pasta samples/:

Cada sample expõe endpoints comparando configuração manual (dentro do endpoint) e global (via IConfigureOptions<T>).

Projetos Relacionados

Licenca

Distribuido sob a licenca MIT.