文档章节

ASP.NET Core 数据保护(Data Protection 集群场景)【下】

丁川
 丁川
发布于 2016/10/18 10:37
字数 2371
阅读 36
收藏 0

前言

接【中篇】,在有一些场景下,我们需要对 ASP.NET Core 的加密方法进行扩展,来适应我们的需求,这个时候就需要使用到了一些 Core 提供的高级的功能。

本文还列举了在集群场景下,有时候我们需要实现自己的一些方法来对Data Protection进行分布式配置。

加密扩展

IAuthenticatedEncryptor 和 IAuthenticatedEncryptorDescriptor

IAuthenticatedEncryptor是 Data Protection 在构建其密码加密系统中的一个基础的接口。
一般情况下一个key 对应一个IAuthenticatedEncryptorIAuthenticatedEncryptor封装了加密操作中需要使用到的秘钥材料和必要的加密算法信息等。

下面是IAuthenticatedEncryptor接口提供的两个 api方法:

Decrypt(ArraySegment<byte> ciphertext, ArraySegment<byte> additionalAuthenticatedData) : byte[]
Encrypt(ArraySegment<byte> plaintext, ArraySegment<byte> additionalAuthenticatedData) : byte[]

其中接口中的参数additionalAuthenticatedData表示在构建加密的时候提供的一些附属信息。

IAuthenticatedEncryptorDescriptor接口提供了一个创建包含类型信息IAuthenticatedEncryptor实例方法。

CreateEncryptorInstance() : IAuthenticatedEncryptor
ExportToXml() : XmlSerializedDescriptorInfo

密钥管理扩展

在密钥系统管理中,提供了一个基础的接口IKey,它包含以下属性:

Activation
creation
expiration dates
Revocation status
Key identifier (a GUID)

IKey还提供了一个创建IAuthenticatedEncryptor实例的方法CreateEncryptorInstance。

IKeyManager接口提供了一系列用来操作Key的方法,包括存储,检索操作等。他提供的高级操作有:

  • 创建一个Key 并且持久存储
  • 从存储库中获取所有的 Key
  • 撤销保存到存储中的一个或多个键

XmlKeyManager
通常情况下,开发人员不需要去实现IKeyManager来自定义一个 KeyManager。我们可以使用系统默认提供的XmlKeyManager类。

XMLKeyManager是一个具体实现IKeyManager的类,它提供了一些非常有用的方法。

public sealed class XmlKeyManager : IKeyManager, IInternalXmlKeyManager
{
    public XmlKeyManager(IXmlRepository repository, IAuthenticatedEncryptorConfiguration configuration, IServiceProvider services);

    public IKey CreateNewKey(DateTimeOffset activationDate, DateTimeOffset expirationDate);
    public IReadOnlyCollection<IKey> GetAllKeys();
    public CancellationToken GetCacheExpirationToken();
    public void RevokeAllKeys(DateTimeOffset revocationDate, string reason = null);
    public void RevokeKey(Guid keyId, string reason = null);
}
  • IAuthenticatedEncryptorConfiguration 主要是规定新 Key 使用的算法。
  • IXmlRepository 主要控制 Key 在哪里持久化存储。

IXmlRepository

IXmlRepository接口主要提供了持久化以及检索XML的方法,它只要提供了两个API:

  • GetAllElements() : IReadOnlyCollection
  • StoreElement(XElement element, string friendlyName)

我们可以通过实现IXmlRepository接口的StoreElement方法来定义data protection xml的存储位置。

GetAllElements来检索所有存在的加密的xml文件。

接口部分写到这里吧,因为这一篇我想把重点放到下面,更多接口的介绍大家还是去官方文档看吧~

集群场景

上面的API估计看着有点枯燥,那我们就来看看我们需要在集群场景下借助于Data Protection来做点什么吧。

就像我在【上篇】总结中末尾提到的,在做分布式集群的时候,Data Protection的一些机制我们需要知道,因为如果不了解这些可能会给你的部署带来一些麻烦,下面我们就来看看吧。

在做集群的时,我们必须知道并且明白关于 ASP.NET Core Data Protection 的三个东西:

1、程序识别者

“Application discriminator”,它是用来标识应用程序的唯一性。
为什么需要这个东西呢?因为在集群环境中,如果不被具体的硬件机器环境所限制,就要排除运行机器的一些差异,就需要抽象出来一些特定的标识,来标识应用程序本身并且使用该标识来区分不同的应用程序。这个时候,我们可以指定ApplicationDiscriminator

services.AddDataProtection(DataProtectionOptions option)的时候,ApplicationDiscriminator可以作为参数传递,来看一下代码:

public void ConfigureServices(IServiceCollection services) 
{
    services.AddDataProtection();

    services.AddDataProtection(DataProtectionOptions option);
}

//===========扩展方法如下:

public static class DataProtectionServiceCollectionExtensions
{
    public static IDataProtectionBuilder AddDataProtection(this IServiceCollection services);
    
    //具有可传递参数的重载,在集群环境中需要使用此项配置
    public static IDataProtectionBuilder AddDataProtection(this IServiceCollection services, Action<DataProtectionOptions> setupAction);
}

// DataProtectionOptions 属性:
public class DataProtectionOptions
{
    public string ApplicationDiscriminator { get; set; }
}

可以看到这个扩展返回的是一个IDataProtectionBuilder,在IDataProtectionBuilder还有一个扩展方法叫 SetApplicationName ,这个扩展方法在内部还是修改的ApplicationDiscriminator的值。也就说以下写法是等价的:

services.AddDataProtection(x => x.ApplicationDiscriminator = "my_app_sample_identity");

services.AddDataProtection().SetApplicationName("my_app_sample_identity");

也就是说集群环境下同一应用程序他们需要设定为相同的值(ApplicationName or ApplicationDiscriminator)。

2、主加密键

“Master encryption key”,主要是用来加密解密的,包括一客户端服务器在请求的过程中的一些会话数据,状态等。有几个可选项可以配置,比如使用证书或者是windows DPAPI或者注册表等。如果是非windows平台,注册表和Windows DPAPI就不能用了。

public void ConfigureServices(IServiceCollection services) 
{
    services.AddDataProtection()
    
    //windows dpaip 作为主加密键
    .ProtectKeysWithDpapi()
    
    //如果是 windows 8+ 或者windows server2012+ 可以使用此选项(基于Windows DPAPI-NG)
    .ProtectKeysWithDpapiNG("SID={current account SID}", DpapiNGProtectionDescriptorFlags.None)
    
    //如果是 windows 8+ 或者windows server2012+ 可以使用此选项(基于证书)
    .ProtectKeysWithDpapiNG("CERTIFICATE=HashId:3BCE558E2AD3E0E34A7743EAB5AEA2A9BD2575A0", DpapiNGProtectionDescriptorFlags.None)
    
    //使用证书作为主加密键,目前只有widnows支持,linux还不支持。
    .ProtectKeysWithCertificate();
}

如果在集群环境中,他们需要具有配置相同的主加密键。

3、加密后存储位置

在【上篇】的时候说过,默认情况下Data Protection会生成 xml 文件用来存储session或者是状态的密钥文件。这些文件用来加密或者解密session等状态数据。

就是上篇中说的那个私钥存储位置:

1、如果程序寄宿在 Microsoft Azure下,存储在“%HOME%\ASP.NET\DataProtection-Keys” 文件夹。
2、如果程序寄宿在IIS下,它被保存在HKLM注册表的ACLed特殊注册表键,并且只有工作进程可以访问,它使用windows的DPAPI加密。
3、如果当前用户可用,即win10或者win7中,它存储在“%LOCALAPPDATA%\ASP.NET\DataProtection-Keys”文件夹,同样使用的windows的DPAPI加密。
4、如果这些都不符合,那么也就是私钥是没有被持久化的,也就是说当进程关闭的时候,生成的私钥就丢失了。

集群环境下:
最简单的方式是通过文件共享、DPAPI或者注册表,也就是说把加密过后的xml文件都存储在相同的地方。为什么说最简单,因为系统已经给封装好了,不需要写多余的代码了,但是要保证文件共享相关的端口是开放的。如下:

public void ConfigureServices(IServiceCollection services) 
{
    services.AddDataProtection()
    //windows、Linux、macOS 下可以使用此种方式 保存到文件系统
    .PersistKeysToFileSystem(new System.IO.DirectoryInfo("C:\\share_keys\\"))
    //windows 下可以使用此种方式  保存到注册表
    .PersistKeysToRegistry(Microsoft.Win32.RegistryKey.FromHandle(null)) 
}

你也可以自己扩展方法来自己定义一些存储,比如使用数据库或者Redis等。

不过通常情况下,如果在linux上部署的话,都是需要扩展的。下面来看一下我们想要用redis存储,该怎么做呢?

如何扩展加密键集合的存储位置?

首先,定义个针对IXmlRepository接口的 redis 实现类RedisXmlRepository.cs

public class RedisXmlRepository : IXmlRepository, IDisposable
{

    public static readonly string RedisHashKey = "DataProtectionXmlRepository";
    
    private IConnectionMultiplexer _connection;
    
    private bool _disposed = false;
    
    public RedisXmlRepository(string connectionString, ILogger<RedisXmlRepository> logger)
        : this(ConnectionMultiplexer.Connect(connectionString), logger)
    {
    }
    
    public RedisXmlRepository(IConnectionMultiplexer connection, ILogger<RedisXmlRepository> logger)
    {
        if (connection == null)
        {
            throw new ArgumentNullException(nameof(connection));
        }
    
        if (logger == null)
        {
            throw new ArgumentNullException(nameof(logger));
        }
    
        this._connection = connection;
        this.Logger = logger;
    
        var configuration = Regex.Replace(this._connection.Configuration, @"password\s*=\s*[^,]*", "password=****", RegexOptions.IgnoreCase);
        this.Logger.LogDebug("Storing data protection keys in Redis: {RedisConfiguration}", configuration);
    }
    
    public ILogger<RedisXmlRepository> Logger { get; private set; }
    
    public void Dispose()
    {
        this.Dispose(true);
    }
    public IReadOnlyCollection<XElement> GetAllElements()
    {
        var database = this._connection.GetDatabase();
        var hash = database.HashGetAll(RedisHashKey);
        var elements = new List<XElement>();
    
        if (hash == null || hash.Length == 0)
        {
            return elements.AsReadOnly();
        }
    
        foreach (var item in hash.ToStringDictionary())
        {
            elements.Add(XElement.Parse(item.Value));
        }
    
        this.Logger.LogDebug("Read {XmlElementCount} XML elements from Redis.", elements.Count);
        return elements.AsReadOnly();
    }
    
    public void StoreElement(XElement element, string friendlyName)
    {
        if (element == null)
        {
            throw new ArgumentNullException(nameof(element));
        }
    
        if (string.IsNullOrEmpty(friendlyName))
        {
            friendlyName = Guid.NewGuid().ToString();
        }
    
        this.Logger.LogDebug("Storing XML element with friendly name {XmlElementFriendlyName}.", friendlyName);
    
        this._connection.GetDatabase().HashSet(RedisHashKey, friendlyName, element.ToString());
    }
    protected virtual void Dispose(bool disposing)
    {
        if (!this._disposed)
        {
            if (disposing)
            {
                if (this._connection != null)
                {
                    this._connection.Close();
                    this._connection.Dispose();
                }
            }
    
            this._connection = null;
            this._disposed = true;
        }
    }
}

然后任意一个扩展类中先定义一个扩展方法:

public static IDataProtectionBuilder PersistKeysToRedis(this IDataProtectionBuilder builder, string redisConnectionString)
{
    if (builder == null)
    {
        throw new ArgumentNullException(nameof(builder));
    }

    if (redisConnectionString == null)
    {
        throw new ArgumentNullException(nameof(redisConnectionString));
    }

    if (redisConnectionString.Length == 0)
    {
        throw new ArgumentException("Redis connection string may not be empty.", nameof(redisConnectionString));
    }
    
    //因为在services.AddDataProtection()的时候,已经注入了IXmlRepository,所以应该先移除掉
    //此处应该封装成为一个方法来调用,为了读者好理解,我就直接写了
    for (int i = builder.Services.Count - 1; i >= 0; i--)
    {
        if (builder.Services[i]?.ServiceType == descriptor.ServiceType)
        {
            builder.Services.RemoveAt(i);
        }
    }

        var descriptor = ServiceDescriptor.Singleton<IXmlRepository>(services => new RedisXmlRepository(redisConnectionString, services.GetRequiredService<ILogger<RedisXmlRepository>>()))
        
        builder.Services.Add(descriptor);
        
        return builder.Use();
}

最终Services中关于DataProtection是这样的:

public void ConfigureServices(IServiceCollection services) 
{
    services.AddDataProtection()
    
    // ================以下是唯一标识==============
    
    //设置应用程序唯一标识
    .SetApplicationName("my_app_sample_identity");
    
    
    // =============以下是主加密键===============
    
    //windows dpaip 作为主加密键
    .ProtectKeysWithDpapi()
    
    //如果是 windows 8+ 或者windows server2012+ 可以使用此选项(基于Windows DPAPI-NG)
    .ProtectKeysWithDpapiNG("SID={current account SID}", DpapiNGProtectionDescriptorFlags.None)
    
    //如果是 windows 8+ 或者windows server2012+ 可以使用此选项(基于证书)
    .ProtectKeysWithDpapiNG("CERTIFICATE=HashId:3BCE558E2AD3E0E34A7743EAB5AEA2A9BD2575A0", DpapiNGProtectionDescriptorFlags.None)
    
    //使用证书作为主加密键,目前只有widnows支持,linux还不支持。
    .ProtectKeysWithCertificate();
    
    
    // ==============以下是存储位置=================
    
    //windows、Linux、macOS 下可以使用此种方式 保存到文件系统
    .PersistKeysToFileSystem(new System.IO.DirectoryInfo("C:\\share_keys\\"))
    
    //windows 下可以使用此种方式  保存到注册表
    .PersistKeysToRegistry(Microsoft.Win32.RegistryKey.FromHandle(null)) 
    
     // 存储到redis
    .PersistKeysToRedis(Configuration.Section["RedisConnection"])
}

在上面的配置中,我把所有可以使用的配置都列出来了哦,实际项目中应该视实际情况选择。

总结

关于ASP.NET Core Data Protection 系列终于写完了,其实这这部分花了蛮多时间的,对于Data Protection来说我也是一个循循渐进的学习过程,希望能帮助到一些人。

本文转载自:http://www.cnblogs.com/savorboard/p/dotnetcore-data-protected-farm.html

共有 人打赏支持
丁川
粉丝 4
博文 52
码字总数 4829
作品 0
南宁
程序员
ASP.NET Core 数据保护(Data Protection)【上】

数据安全往往是开发人员很容易忽略的一个部分,包括我自己。近两年业内也出现了很多因为安全问题导致了很多严重事情发生,所以安全对我们开发人员很重要,我们要对我们的代码的安全负责。 在...

鼎六智能
2016/10/18
106
0
ASP.NET Core 数据保护(Data Protection)【中】

API 接口 ASP.NET Core Data Protectio 主要对普通开发人员提供了两个接口, 和 。 我们先看一下这两个接口的关系: 可以看到,继承自 ,并且提供了两个方法 和 ,从命名来看,一个是加密,一...

鼎六智能
2016/10/18
26
0
.NET Core开发日志——配置

熟悉ASP.NET的开发者一定对web.config文件不陌生。在ASP.NET环境中,要想添加配置参数,一般也都会在此文件中操作。其中最常用的莫过于AppSettings与ConnectionStrings两项。而要在代码中获得...

Ken.W
08/05
0
0
泥水佬/FastHttpApi

FastHttpApi 简介 是基于dotcore实现的一个高度精简化和高吞吐的HTTP API服务组件,它并没有完全实现HTTP SERVER的所有功能,而是只实现了在APP和WEB中提供数据服务最常用两个指令GET/SET,满...

泥水佬
09/14
0
0
用分布式缓存提升ASP.NET Core性能

得益于纯净、轻量化并且跨平台支持的特性,ASP.NET Core作为热门Web应用开发框架,其高性能传输和负载均衡的支持已广受青睐。实际上,10-20台Web服务器还是轻松驾驭的。有了多服务器负载的支...

04/13
0
0

没有更多内容

加载失败,请刷新页面

加载更多

elastic search+kibana 5.6.12安装指南

前提准备: 1,安装jdk, We recommend installing Java version 1.8.0_131 or later. 2, 设置文件最大打开数(使用命令ulimit -n查看) ulimit -n 65536 3, 创建用户elastic/用户组elastic gro...

PageYi
20分钟前
1
0
安装mongodb碰到error: unpacking of archive failed on file /etc/init.d/mongod;5bcec214: cpio: open如何解决

今用yum安装mongodb4.0.3发现一个错误,当用yum install 安装mongo-org 时除了mongodb-org-server 没有安装以外其他的都安装正确,重新安装mongodb-org-server 时报如下错误信息 在一篇老外 ...

chanking
21分钟前
1
0
O2OA:企业办公数字化转型的更佳选择

在全球都在积极探索由新一轮信息技术所引发的第四次工业革命时,一场激发企业内生动力的数字化运动在互联网企业和传统企业之间却呈现出两种截然不同的状态。   传统企业办公数字化不彻底仍...

超能之法师
24分钟前
1
0
基于SylixOS 对 Goahead 进行配置使用 OpenSSL

1. 编译并部署OpenSSL SylixOS支持OpenSSL,git地址为:http://git.sylixos.com/repo/openssl.git 获取OpenSSL工程源码后,导入RealEvo-IDE中编译,编译完成后生成动态库文件和openssl可执行...

Baiqq
27分钟前
1
0
nginx+tomcat均衡负载

一、安装好nginx环境,启动至少两个的tomcat服务; 此处tomcat访问地址为:http://192.168.106.128:1000/、http://192.168.106.128:1001/、http://192.168.106.128:1002/ 二、修改nginx配置文...

狼王黄师傅
28分钟前
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部