Introdução às APIs de Proteção de Dados no ASP.NET Core

Basicamente, a proteção de dados consiste nas seguintes etapas:

1. Criar um protetor de dados a partir de um provedor de proteção de dados.
2. Chamar o método Protect com os dados que você deseja proteger.
3. Chamar o método Unprotect com os dados que você deseja transformar em texto sem formatação.

A maioria das estruturas e modelos de aplicativo, como ASP.NET Core ou SignalR, já configura o sistema de proteção de dados e o adiciona a um contêiner de serviço que é acessado por meio de injeção de dependência. O exemplo a seguir demonstra:

• Configurar um contêiner de serviço para injeção de dependência e registrar a pilha de proteção de dados.
• Receber o provedor de proteção de dados por meio da DI.
• Criar um protetor.
• Proteger e desproteger dados.

using System;
using Microsoft.AspNetCore.DataProtection;
using Microsoft.Extensions.DependencyInjection;

public class Program
{
    public static void Main(string[] args)
    {
        // add data protection services
        var serviceCollection = new ServiceCollection();
        serviceCollection.AddDataProtection();
        var services = serviceCollection.BuildServiceProvider();

        // create an instance of MyClass using the service provider
        var instance = ActivatorUtilities.CreateInstance<MyClass>(services);
        instance.RunSample();
    }

    public class MyClass
    {
        IDataProtector _protector;

        // the 'provider' parameter is provided by DI
        public MyClass(IDataProtectionProvider provider)
        {
            _protector = provider.CreateProtector("Contoso.MyClass.v1");
        }

        public void RunSample()
        {
            Console.Write("Enter input: ");
            string input = Console.ReadLine();

            // protect the payload
            string protectedPayload = _protector.Protect(input);
            Console.WriteLine($"Protect returned: {protectedPayload}");

            // unprotect the payload
            string unprotectedPayload = _protector.Unprotect(protectedPayload);
            Console.WriteLine($"Unprotect returned: {unprotectedPayload}");
        }
    }
}

/*
 * SAMPLE OUTPUT
 *
 * Enter input: Hello world!
 * Protect returned: CfDJ8ICcgQwZZhlAlTZT...OdfH66i1PnGmpCR5e441xQ
 * Unprotect returned: Hello world!
 */

Ao criar um protetor, você deve fornecer uma ou mais Cadeias de Caracteres de Finalidade. Uma cadeia de caracteres de finalidade fornece isolamento entre os consumidores. Por exemplo, um protetor criado com uma cadeia de caracteres de finalidade "verde" não seria capaz de desproteger dados fornecidos por um protetor com a finalidade "roxo".

Usar AddOptions para configurar o repositório personalizado

Considere o seguinte código que usa um provedor de serviços porque a implementação de IXmlRepository tem uma dependência em um serviço singleton:

public void ConfigureServices(IServiceCollection services)
{
    // ...

    var sp = services.BuildServiceProvider();
    services.AddDataProtection()
      .AddKeyManagementOptions(o => o.XmlRepository = sp.GetService<IXmlRepository>());
}

O código anterior registra o seguinte aviso:

O Asp0000 chamando “BuildServiceProvider” do código do aplicativo resulta em uma cópia adicional dos serviços singleton sendo criados. Considere alternativas como a injeção de serviços de dependência como parâmetros para "Configurar".

O código a seguir fornece a implementação IXmlRepository sem precisar criar o provedor de serviços e, portanto, fazer cópias adicionais de serviços singleton:

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<DataProtectionDbContext>(options =>
        options.UseSqlServer(
            Configuration.GetConnectionString("DefaultConnection")));

    // Register XmlRepository for data protection.
    services.AddOptions<KeyManagementOptions>()
    .Configure<IServiceScopeFactory>((options, factory) =>
    {
        options.XmlRepository = new CustomXmlRepository(factory);
    });

    services.AddRazorPages();
}

O código anterior remove a chamada a GetService e oculta IConfigureOptions<T>.

O código a seguir mostra o repositório XML personalizado:

using CustomXMLrepo.Data;
using Microsoft.AspNetCore.DataProtection.Repositories;
using Microsoft.Extensions.DependencyInjection;
using System.Collections.Generic;
using System.Linq;
using System.Xml.Linq;

public class CustomXmlRepository : IXmlRepository
{
    private readonly IServiceScopeFactory factory;

    public CustomXmlRepository(IServiceScopeFactory factory)
    {
        this.factory = factory;
    }

    public IReadOnlyCollection<XElement> GetAllElements()
    {
        using (var scope = factory.CreateScope())
        {
            var context = scope.ServiceProvider.GetRequiredService<DataProtectionDbContext>();
            var keys = context.XmlKeys.ToList()
                .Select(x => XElement.Parse(x.Xml))
                .ToList();
            return keys;
        }
    }

    public void StoreElement(XElement element, string friendlyName)
    {
        var key = new XmlKey
        {
            Xml = element.ToString(SaveOptions.DisableFormatting)
        };

        using (var scope = factory.CreateScope())
        {
            var context = scope.ServiceProvider.GetRequiredService<DataProtectionDbContext>();
            context.XmlKeys.Add(key);
            context.SaveChanges();
        }
    }
}

O código a seguir mostra a classe XmlKey:

public class XmlKey
{
    public Guid Id { get; set; }
    public string Xml { get; set; }

    public XmlKey()
    {
        this.Id = Guid.NewGuid();
    }
}