自定义 JsonConfigurationProvider - ASP.NET Core 使用错误的实现答案

【问题标题】：Custom JsonConfigurationProvider - ASP.NET Core uses wrong implementation自定义 JsonConfigurationProvider - ASP.NET Core 使用错误的实现
【发布时间】：2018-06-14 13:10:33
【问题描述】：

我尝试实现一个名为“CryptographyConfigProvider”的自定义 JsonConfigurationProvider，如果它被加密，它会从流中解密 JSON。

我继承自 JsonConfigurationProvider 并实现了自定义加载方法。

我在 Program.cs 中这样使用它：

  var configuration = new ConfigurationBuilder()
                .AddEncryptedJsonFile($"appsettings.{enviromentValue}.json", optional: true, reloadOnChange: false)
                .Build();

此调用执行我的自定义实现。（见下文）

但是在这个 ASP.NET Core 尝试在这里再次访问 appsettings 文件之后：

 webHostBuilder.Build().Run();

异常表示调用的是普通的JsonConfigurationProvider，而不是我继承的类CryptographyConfigProvider。

System.FormatException: Could not parse the JSON file. Error on line number '0': 'EncryptedString'. 
---> Newtonsoft.Json.JsonReaderException: Unexpected character encountered while parsing value: S. Path '', line 0, position 0.
at Newtonsoft.Json.JsonTextReader.ParseValue()
at Newtonsoft.Json.Linq.JObject.Load(JsonReader reader, JsonLoadSettings settings)
at Microsoft.Extensions.Configuration.Json.JsonConfigurationFileParser.Parse(Stream input)
at Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.Load(Stream stream)
--- End of inner exception stack trace ---
at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load()
at Microsoft.Extensions.Configuration.ConfigurationRoot..ctor(IList`1 providers)
at Microsoft.Extensions.Configuration.ConfigurationBuilder.Build()
at Microsoft.AspNetCore.Hosting.WebHostBuilder.BuildCommonServices(AggregateException& hostingStartupErrors)
at Microsoft.AspNetCore.Hosting.WebHostBuilder.Build()
at Main(String[] args) in Program.cs

有人知道为什么 ASP.NET Core 使用普通的 JsonConfigurationProvider 吗？

这是我的实现：

public static class DecryptionConfigProviderExtension
{
    public static IConfigurationBuilder AddEncryptedJsonFile(this IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange)
    {
        return builder.AddJsonFile(s =>
        {
            s.FileProvider = null;
            s.Path = path;
            s.Optional = optional;
            s.ReloadOnChange = reloadOnChange;
            s.ResolveFileProvider();
        });
    }

    public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, Action<CryptographyConfigurationSource> configureSource) => builder.Add(configureSource);
}

public class CryptographyConfigurationSource : JsonConfigurationSource, IConfigurationSource
{
    public override IConfigurationProvider Build(IConfigurationBuilder builder)
    {
        EnsureDefaults(builder);
        return new CryptographyConfigProvider(this);
    }
}

public class CryptographyConfigProvider : JsonConfigurationProvider
{
    private const string EncryptionKey = "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456";

    private AesCryptography _aesCryptography;

    public CryptographyConfigProvider(CryptographyConfigurationSource cryptographyConfigurationSource) : base(cryptographyConfigurationSource)
    {
        _aesCryptography = new AesCryptography();
    }

    public override void Load(Stream stream)
    {
        Data = UnencryptConfiguration(stream);
    }

    private IDictionary<string, string> UnencryptConfiguration(Stream stream)
    {
        var reader = new StreamReader(stream);
        var text = reader.ReadToEnd();
        var jsonString = DecryptIfEncrypted(text);

        using (MemoryStream jsonStream = new MemoryStream())
        {
            var parser = new JsonConfigurationFileParser();
            StreamWriter writer = new StreamWriter(jsonStream);
            writer.Write(jsonString);
            writer.Flush();
            jsonStream.Position = 0;
            return parser.Parse(jsonStream);
        };
    }

    private string DecryptIfEncrypted(string text)
    {
        var jsonString = string.Empty;

        try
        {
            jsonString = _aesCryptography.DecryptString(text, EncryptionKey);
        }
        catch
        {
            jsonString = text;
        }

        return jsonString;
    }
}

【问题讨论】：

JsonConfigurationFileParser() 类的内容是什么？可以分享一下吗？
@Shuaib 你可以在这里找到它：github.com/aspnet/Configuration/blob/…
@Smashiel 你设法让它工作了吗？
@pantonis 查看已接受的答案。如果它们仍在您的项目中，则需要删除默认的“AddJsonFile”。
JsonConfigurationFileParser 是内部的。假设您创建了一个公开的权利？

标签： c# asp.net-core asp.net-core-2.0

【解决方案1】：

从 .NET Core 2.0 开始，appsettings.{env.EnvironmentName}.json 会自动为您加载。如果您已对其进行加密，则框架可能会在解析它时出现问题。

.ConfigureAppConfiguration((hostingContext, config) =>
{
    ...

    config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
          .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);

    ...

MetaPackages/src/Microsoft.AspNetCore/WebHost.cs

我会尝试为您的文件命名。

我的团队最近实施的另一种解决方案是将机密移动到 app.config 并使用 protected configuration 对其进行加密。自定义配置提供程序读取应用程序设置（例如 Azure:ApiKey）并将它们提供给 Core 框架。

【讨论】：

【解决方案2】：

必须创建自定义提供程序并使用老式 XML 配置文件来处理加密设置是很疯狂的。这应该由框架 IMO 处理。

与此同时，我对this question 的回答是一种非常简单直接的方式来加密设置文件中的值。它使用现有的 JSON 提供程序，首选 .Net Core 加密技术，并且对 DI 友好。

希望对你有帮助！

【讨论】：