Azure KeyVault secret 值在启动期间在 IConfiguration 中不可用

标签 azure asp.net-core .net-core azure-keyvault .net-core-3.1

出于某种原因,我们无法在启动时从 Azure KeyVault 检索 secret 值。虽然 secret 似乎可以通过 IConfiguration 接口(interface)在过程中使用的方法中获得。我猜我们在某个地方做错了,或者可能是来自 Azure 的数据仅在服务初始化完成后可用。

我们正在使用 .net core 3.1 Web api 和 Azure Key Vault 托管身份。

这是与之相关的代码。如果您发现任何奇怪的情况,请告诉我。

我们拥有的 KeyVault secret 名称:MyApp-AppSettings--Key

在Program.cs中

public class Program
{
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((context, config) =>
                {
                    var configurationRoot = ConfigurationBuilder.Build();
                    var keyVaultUrl = configurationRoot["KeyVaultUrl"];

                    config.AddAzureKeyVault(new Uri(keyVaultUrl), new DefaultAzureCredential(), new PrefixKeyVaultSecretManager("myApp"));
                })
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }
}

我们的启动文件如下所示。

public class Startup
{
    public Startup(IWebHostEnvironment env)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
            .AddEnvironmentVariables();
        Configuration = builder.Build();
        ContentRootPath = env.ContentRootPath;
    }

    public IConfiguration Configuration { get; }
    public string ContentRootPath { get; set; }

    public void ConfigureServices(IServiceCollection services)
    {

        services.AddHsts(options =>
        {
            options.Preload = true;
            options.IncludeSubDomains = true;
            options.MaxAge = TimeSpan.FromDays(365);
        });

        **var conf = Configuration.GetSection("AppSettings").Get<Config>();**

        **services.Configure<Config>(Configuration.GetSection("AppSettings"));**

        **services.AddSingleton<IAppSettings>(c => conf);**

        services.RegisterStorage(new StorageConfiguration
        {
            ConnectionString = "ConnectionString",
            Key = Convert.FromBase64String(**conf.Key**) // conf.Key is "". Does not work
        });

        services.AddScoped<IProcessHandler, ProcessHandler>();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        app.UseHsts();
        app.UseHttpsRedirection();
        app.UseHttpStatusCodeExceptionMiddleware();

        app.UseHttpsRedirection();

        app.UseRouting();

        app.UseAuthentication();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }

    private static void LoadMediatorHandlers(IServiceCollection services)
    {
        foreach (var assembly in Assembly
                                 .GetEntryAssembly()
                                 .GetReferencedAssemblies()
                                 .Select(Assembly.Load)
                                 .Where(name => (name.FullName.Contains("Queries") || name.FullName.Contains("Commands"))))
        {
            services.AddMediatR(assembly);
        }
        services.AddMediatR(typeof(Startup));
        services.AddScoped<IMediator, Mediator>();
    }   
}

当我们在进程中调用 ProcessXyz 方法时,该值在 IProcessHandler 中可用。这样做是为了测试我们是否能够从 KeyVault 检索值。

public class ProcessHandler : IProcessHandler
{
    private readonly IConfiguration _configuration;

    public ProcessHandler(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public async Task<ClassA> ProcessXyz()
    {
        var KeyVaultValue = _configuration["AppSettings:Key"]; //This works
    }   
}

请注意:出于安全问题,我刚刚添加了所需的代码并替换了实际名称。

提前致谢

最佳答案

在启动构造函数中,您将创建一个新的配置生成器,该配置生成器具有一组有限的源并且缺少 Azure Key Vault 提供程序。因此,您可以注入(inject) DI 容器中随时可用的配置生成器,而不是创建新的配置生成器。

所以用这个改变启动构造函数。

public Startup(IWebHostEnvironment env, IConfiguration configuration)
{
    Configuration = configuration;
    ContentRootPath = env.ContentRootPath;
}

然后,在 Program 类中准备的配置将用于将其注入(inject)到启动设置中,从而获取已配置的所有不同默认源(包括命令行源)和额外添加的源。

关于Azure KeyVault secret 值在启动期间在 IConfiguration 中不可用,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/71365375/

相关文章:

azure - 如何在 Azure 机器学习中使用历史数据集进行训练并使用预期数据集作为预测的输入

c# - 在 iframe 中使用 .net core 2 AuthorizationHandler 时,为什么身份为 null

.net - 如何使用 Terraform azurerm_app_service 指定 .net core 版本

azure - 在 Docker 中运行的自定义 Azure DevOps 构建代理上安装卷的测试容器

azure - 外键约束 Synapse Azure

Azure 额外订阅

c# - 从 3.1.2 版升级到 5.0.3 版后,Entity Framework 核心 Include() 不起作用

c# - 如何在 xunit 中使用最小起订量测试返回 IEnumerable<model> 的异步任务<IActionResult>?

c# - 只有一个消费者从 RabbitMQ 上的队列接收消息

c# - 如何自动增加 .NET Core 项目的版本(例如 “1.0.*” )?