BotBuilder V3.15.3中如何注入BotAuthentication并传入密钥保管库凭据

我明白你遇到的困境——BotBuilder V3的BotAuthentication特性在指定CredentialProviderType时，确实不支持直接传入构造函数参数，因为它会默认调用无参构造函数来实例化你的凭据提供者。不过我们可以通过让自定义凭据提供者主动从配置（已加载KeyVault机密）中获取值的方式来解决这个问题，具体步骤如下：

核心思路 #

BotAuthentication要求指定的ICredentialProvider实现类必须具备无参数构造函数，所以我们不能直接通过构造函数传递appId和密码。替代方案是让凭据提供者从已加载KeyVault机密的应用配置中读取这些值，或者通过依赖注入容器获取所需的配置服务。

具体实现步骤 #

1. 确保KeyVault机密已加载到应用配置 #

首先在你的ASP.NET Web API项目的Startup.cs中，配置Azure Key Vault作为配置源，把MicrosoftAppId和MicrosoftAppPassword加载到应用配置里：

using Microsoft.Extensions.Configuration;
using System;

public class Startup
{
    public static IConfiguration Configuration { get; private set; }

    public void Configuration(IAppBuilder app)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(AppDomain.CurrentDomain.BaseDirectory)
            .AddJsonFile("web.config") // 基础配置文件
            .AddAzureKeyVault("https://your-keyvault-name.vault.azure.net/"); // 替换为你的KeyVault地址

        Configuration = builder.Build();

        // 可选：把配置值存入静态类，方便后续读取（如果不用依赖注入的话）
        Secrets.MicrosoftAppId = Configuration["MicrosoftAppId"];
        Secrets.MicrosoftAppPassword = Configuration["MicrosoftAppPassword"];

        // 其他Web API配置...
        var config = new HttpConfiguration();
        WebApiConfig.Register(config);
        app.UseWebApi(config);
    }
}

2. 修改自定义凭据提供者为无参构造 #

调整你的NewStaticCredentialProvider，去掉带参数的构造函数，改成无参构造，直接从静态类或配置中读取机密：

public sealed class NewStaticCredentialProvider : SimpleCredentialProvider
{
    public NewStaticCredentialProvider()
    {
        // 从提前初始化的静态Secrets类读取
        this.AppId = Secrets.MicrosoftAppId;
        this.Password = Secrets.MicrosoftAppPassword;
    }
}

如果更倾向于用依赖注入而不是静态类，可以通过Web API的依赖解析器获取IConfiguration：

public sealed class KeyVaultCredentialProvider : SimpleCredentialProvider
{
    public KeyVaultCredentialProvider()
    {
        // 从依赖容器中获取配置服务
        var config = System.Web.Http.GlobalConfiguration.Configuration
            .DependencyResolver.GetService(typeof(IConfiguration)) as IConfiguration;
        
        if (config != null)
        {
            this.AppId = config["MicrosoftAppId"];
            this.Password = config["MicrosoftAppPassword"];
        }
    }
}

3. 更新控制器上的BotAuthentication注解 #

确保注解指向你的无参凭据提供者类型：

[BotAuthentication(CredentialProviderType = typeof(NewStaticCredentialProvider))]
public class MessagesController : ApiController 
{
    // 控制器逻辑...
}

关键注意事项 #

• KeyVault权限配置：确保你的应用服务主体（或托管标识）拥有KeyVault的Get机密权限，否则无法读取机密。
• 配置加载顺序：确保KeyVault配置源在其他配置源之后，这样可以覆盖本地配置中的默认值。
• 依赖注入注册：如果使用依赖注入方式获取IConfiguration，需要提前在Web API的依赖容器中注册IConfiguration实例。

内容的提问来源于stack exchange，提问作者Sunny