ASP.NET Core 中的数据保护 Api 入门Get started with the Data Protection APIs in ASP.NET Core

本文内容

最简单的是保护数据，包括以下步骤：

  • 从数据保护提供程序创建数据保护程序。

  • 用要保护的数据调用 Protect 方法。

  • 用要返回到纯文本的数据调用 Unprotect 方法。

大多数框架和应用模型（如 ASP.NET Core 或 SignalR）已配置数据保护系统，并将其添加到通过依赖关系注入访问的服务容器。下面的示例演示如何为依赖关系注入配置服务容器并注册数据保护堆栈，通过 DI 接收数据保护提供程序，创建保护程序并保护然后取消保护数据。

  1. using System;
  2. using Microsoft.AspNetCore.DataProtection;
  3. using Microsoft.Extensions.DependencyInjection;
  5. public class Program
  6. {
  7.     public static void Main(string[] args)
  8.     {
  9.         // add data protection services
  10.         var serviceCollection = new ServiceCollection();
  11.         serviceCollection.AddDataProtection();
  12.         var services = serviceCollection.BuildServiceProvider();
  14.         // create an instance of MyClass using the service provider
  15.         var instance = ActivatorUtilities.CreateInstance<MyClass>(services);
  16.         instance.RunSample();
  17.     }
  19.     public class MyClass
  20.     {
  21.         IDataProtector _protector;
  23.         // the 'provider' parameter is provided by DI
  24.         public MyClass(IDataProtectionProvider provider)
  25.         {
  26.             _protector = provider.CreateProtector("Contoso.MyClass.v1");
  27.         }
  29.         public void RunSample()
  30.         {
  31.             Console.Write("Enter input: ");
  32.             string input = Console.ReadLine();
  34.             // protect the payload
  35.             string protectedPayload = _protector.Protect(input);
  36.             Console.WriteLine($"Protect returned: {protectedPayload}");
  38.             // unprotect the payload
  39.             string unprotectedPayload = _protector.Unprotect(protectedPayload);
  40.             Console.WriteLine($"Unprotect returned: {unprotectedPayload}");
  41.         }
  42.     }
  43. }
  45. /*
  46.  * SAMPLE OUTPUT
  47.  *
  48.  * Enter input: Hello world!
  49.  * Protect returned: CfDJ8ICcgQwZZhlAlTZT...OdfH66i1PnGmpCR5e441xQ
  50.  * Unprotect returned: Hello world!
  51.  */

创建保护程序时，必须提供一个或多个目的字符串。用途字符串提供使用者之间的隔离。例如，使用 "绿色" 目的字符串创建的保护程序将无法取消保护由 "紫色" 目的的保护程序提供的数据。

提示

IDataProtectionProvider 和 IDataProtector 的实例对于多个调用方是线程安全的。它的目的是，在组件通过调用 CreateProtector获取对 IDataProtector 的引用时，它会将该引用用于多次调用 Protect 和 Unprotect。

如果无法验证或解密受保护的有效负载，则对 Unprotect 的调用将引发 System.security.cryptography.cryptographicexception。某些组件可能希望在取消保护操作期间忽略错误;读取身份验证 cookie 的组件可能会处理此错误，并将请求视为根本没有 cookie，而不是完全失败的请求。需要此行为的组件应专门捕获 System.security.cryptography.cryptographicexception，而不是抑制所有异常。