Rozpocznij pracę z interfejsami API ochrony danych w usłudze ASP.NET Core

Zasadniczo ochrona danych składa się z następujących kroków:

  1. Utwórz moduł ochrony danych przy użyciu dostawcy ochrony danych.
  2. Wywołaj metodę Protect z danymi, które chcesz chronić.
  3. Wywołaj metodę Unprotect z danymi, które chcesz przywrócić do zwykłego tekstu.

Większość frameworków i modeli aplikacji, takich jak ASP.NET Core lub SignalR, już konfiguruje system ochrony danych i dodaje go do kontenera usług, który jest dostępny za pośrednictwem wstrzykiwania zależności. W poniższym przykładzie pokazano:

  • Konfigurowanie kontenera usług na potrzeby wstrzykiwania zależności i rejestrowania stosu ochrony danych.
  • Pobieranie dostawcy ochrony danych za pośrednictwem DI.
  • Tworzenie ochraniacza.
  • Ochrona danych, a następnie cofnięcie ich ochrony.
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!
 */

Podczas tworzenia modułu ochrony należy podać co najmniej jeden ciąg celu. Ciąg purpose zapewnia izolację między odbiorcami. Na przykład moduł ochrony utworzony z ciągiem przeznaczenia „zielony” nie będzie mógł wyłączyć ochrony danych dostarczonych przez moduł ochrony z przeznaczeniem „purpurowy”.

Napiwek

Wystąpienia IDataProtectionProvider i IDataProtector są bezpieczne wątkowo dla wielu wywołujących. Zakłada się, że gdy składnik pobiera odwołanie do elementu IDataProtector za pośrednictwem wywołania metody CreateProtector, będzie używać tego odwołania dla wielu wywołań do Protect i Unprotect.

Wywołanie Unprotect spowoduje zgłoszenie wyjątku CryptographicException, jeśli nie można zweryfikować ani odszyfrować chronionego ładunku. Niektóre składniki mogą chcieć ignorować błędy podczas operacji usuwania ochrony; składnik, który odczytuje pliki cookie uwierzytelniania, może obsłużyć ten błąd i traktować żądanie tak, jakby w ogóle nie było cookie, zamiast od razu odrzucić żądanie. Składniki, które chcą tego zachowania, powinny przechwytywać wyjątek CryptographicException zamiast połykać wszystkie wyjątki.

Konfigurowanie repozytorium niestandardowego za pomocą polecenia AddOptions

Rozważ następujący kod, który używa dostawcy usług, ponieważ implementacja IXmlRepository ma zależność od usługi singleton:

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

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

Powyższy kod rejestruje następujące ostrzeżenie:

Wywołanie metody "BuildServiceProvider" z kodu aplikacji powoduje utworzenie dodatkowej kopii usług singleton. Rozważ alternatywy, takie jak wstrzykiwanie zależności jako parametrów do „Configure”.

Poniższy kod zapewnia implementację IXmlRepository bez konieczności tworzenia dostawcy usług, a tym samym tworzenia dodatkowych kopii pojedynczych usług:

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();
}

Powyższy kod usuwa wywołanie GetService i ukrywa IConfigureOptions<T>.

Poniższy kod przedstawia niestandardowe repozytorium XML:

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();
        }
    }
}

Poniższy kod przedstawia klasę XmlKey:

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

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