EZ.Redact.Lgpd.Xml 2.1.1

EZ.Redact.Lgpd.Xml

Extensão de serialização para o EZ.Redact.Lgpd.Core. Redige dados pessoais automaticamente durante a serialização XML com XmlSerializer e DataContractSerializer, sem precisar chamar ILGPDRedactService manualmente.

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

Para classes geradas a partir de XSD: os atributos LGPD precisam ser adicionados manualmente, pois o gerador do xsd.exe / dotnet xsd não os inclui. Você pode usar partial class para estender os tipos gerados e decorar as propriedades com os atributos de redação.

Instalação

dotnet add package EZ.Redact.Lgpd.Xml

Registre os serviços no DI:

using Microsoft.Extensions.DependencyInjection;

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

AddXmlRedaction() registra os serializadores RedactingXmlSerializer e RedactingDataContractSerializer como singletons no DI.

Exemplo rápido

using EZ.Redact.Lgpd.Xml.XmlSerializer;

var redactor = serviceProvider.GetRequiredService<RedactingXmlSerializer>();
var xml = redactor.Serialize(pessoa);
// <Pessoa><Nome>J*** S****</Nome><Documento>123.***.***-09</Documento></Pessoa>

Todos os dados sensíveis decorados com atributos LGPD serão redigidos automaticamente durante a serialização XML.

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 com XmlSerializer

Utilize RedactingXmlSerializer — registrado automaticamente pelo AddXmlRedaction():

using EZ.Redact.Lgpd.Xml.XmlSerializer;

app.MapGet("/xml", (RedactingXmlSerializer redactor) =>
{
    var pessoa = new Pessoa
    {
        Nome = "Felipe Siqueira",
        Documento = "123.456.789-09",
        Email = "felipe.siqueira@gmail.com"
    };

    return Results.Content(redactor.Serialize(pessoa), "application/xml");
});

Saída redigida

<Pessoa>
  <Nome>F***** S*******</Nome>
  <Documento>123.***.***-09</Documento>
  <Email>f**************@gmail.com</Email>
</Pessoa>

Serializar para Stream ou TextWriter

using var stream = new MemoryStream();
redactor.Serialize(pessoa, stream);

Uso com DataContractSerializer

Utilize RedactingDataContractSerializer — também registrado pelo AddXmlRedaction():

using EZ.Redact.Lgpd.Xml.DataContractSerializer;

app.MapGet("/dc", (RedactingDataContractSerializer redactor) =>
{
    var pessoa = new PessoaContrato
    {
        Nome = "Felipe Siqueira",
        Documento = "123.456.789-09"
    };

    return Results.Content(redactor.Serialize(pessoa), "application/xml");
});

O modelo precisa dos atributos [DataContract] / [DataMember]:

[DataContract]
public class PessoaContrato
{
    [DataMember]
    [NomeData]
    public string? Nome { get; set; }

    [DataMember]
    [CPFData]
    public string? Documento { get; set; }
}

Saída redigida

<PessoaContrato>
  <Nome>F***** S*******</Nome>
  <Documento>123.***.***-09</Documento>
</PessoaContrato>

Atributos Suportados

Os atributos são definidos pelo pacote EZ.Redact.Lgpd.Core e funcionam com qualquer serializador XML.

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.Xml.Sample
curl http://localhost:5000/xml
curl http://localhost:5000/dc

Projetos Relacionados

Licenca

Distribuido sob a licenca MIT.