自动轮换使用一组身份验证凭据的资源的机密

向 Azure 服务进行身份验证的最佳方法是使用托管标识,但某些情况下无法做到这一点。 在此类情况下,将使用访问密钥或机密。 应定期轮换访问密钥或机密。

本教程介绍如何定期自动轮换使用一组身份验证凭据的数据库和服务的机密。 具体而言,本教程将使用 Azure 事件网格通知触发的函数来轮换 Azure Key Vault 中存储的 SQL Server 密码:

Diagram of rotation solution

  1. 在机密过期之前的 30 天,Key Vault 会向事件网格发布“即将过期”事件。
  2. 事件网格会检查事件订阅,并使用 HTTP POST 调用已订阅该事件的函数应用终结点。
  3. 函数应用接收机密信息,生成新的随机密码,然后在 Key Vault 中使用新密码为机密创建新的版本。
  4. 函数应用使用新密码更新 SQL Server。

注意

步骤 3 与 4 之间可能会存在滞后现象。 在此期间,Key Vault 中的机密无法向 SQL Server 进行身份验证。 如果任一步骤失败,事件网格将重试两小时。

先决条件

如果没有现成的 Key Vault 和 SQL Server,可以使用以下部署链接:

Image showing a button labeled

  1. 在“资源组”下,选择“新建”。 为组命名,我们将在本教程中使用 akvrotation。
  2. 在“Sql 管理员登录名”下,键入 Sql 管理员登录名。
  3. 选择“查看 + 创建”。
  4. 选择“创建”

Create a resource group

现在,你已拥有一个 Key Vault 和一个 SQL Server 实例。 可以在 Azure CLI 中运行以下命令来验证此设置:

az resource list -o table -g akvrotation

结果类似于以下输出:

Name                     ResourceGroup         Location    Type                               Status
----------------------- --------------------  ---------- ---------------------------------  --------
akvrotation-kv           akvrotation      chinaeast      Microsoft.KeyVault/vaults
akvrotation-sql          akvrotation      chinaeast      Microsoft.Sql/servers
akvrotation-sql/master   akvrotation      chinaeast      Microsoft.Sql/servers/databases
akvrotation-sql2         akvrotation      chinaeast      Microsoft.Sql/servers
akvrotation-sql2/master  akvrotation      chinaeast      Microsoft.Sql/servers/databases

创建和部署 sql server 密码轮替函数

重要

以下模板要求 Key Vault、SQL Server 和 Azure 函数位于同一资源组中

接下来,创建一个使用系统托管标识的函数应用以及其他所需组件,并部署 sql server 密码轮替函数

该函数应用需要以下组件:

  • 一个 Azure 应用服务计划
  • 一个包含具有事件触发器和 http 触发器的 sql 密码轮替函数的函数应用
  • 进行函数应用触发器管理时所需的存储帐户
  • 一个用于访问 Key Vault 中机密的函数应用标识的访问策略
  • “SecretNearExpiry”事件的 EventGrid 事件订阅
  1. 选择 Azure 模板部署链接:

    Image showing a button labeled

  2. 在“资源组”列表中选择“akvrotation” 。

  3. 在“Sql Server 名称”中,键入密码需进行轮替的 Sql Server 名称

  4. 在“密钥保管库名称”中,键入密钥保管库名称

  5. 在“函数应用名称”中,键入函数应用名称

  6. 在“机密名称”中,键入将在其中存储密码的机密名称

  7. 在“存储库 Url”中,键入函数代码 GitHub 位置 (https://github.com/Azure-Samples/KeyVault-Rotation-SQLPassword-Csharp.git)

  8. 选择“查看 + 创建”。

  9. 选择“创建”。

Select Review+create

完成上述步骤后,你将获得一个存储帐户、一个服务器场和一个函数应用。 可以在 Azure CLI 中运行以下命令来验证此设置:

az resource list -o table -g akvrotation

结果类似于以下输出:

Name                     ResourceGroup         Location    Type                               Status
-----------------------  --------------------  ----------  ---------------------------------  --------
akvrotation-kv           akvrotation       chinaeast      Microsoft.KeyVault/vaults
akvrotation-sql          akvrotation       chinaeast      Microsoft.Sql/servers
akvrotation-sql/master   akvrotation       chinaeast      Microsoft.Sql/servers/databases
cfogyydrufs5wazfunctions akvrotation       chinaeast      Microsoft.Storage/storageAccounts
akvrotation-fnapp        akvrotation       chinaeast      Microsoft.Web/serverFarms
akvrotation-fnapp        akvrotation       chinaeast      Microsoft.Web/sites
akvrotation-fnapp        akvrotation       chinaeast      Microsoft.insights/components

有关如何创建函数应用和使用托管标识访问密钥保管库的信息,请参阅从 Azure 门户创建函数应用如何将托管标识用于应用服务和 Azure Functions 以及使用 Azure 门户分配密钥保管库访问策略

轮换函数

在先前步骤中部署的函数使用事件通过更新 Key Vault 和 SQL 数据库来触发机密轮替。

函数触发器事件

此函数读取事件数据并运行轮换逻辑:

public static class SimpleRotationEventHandler
{
   [FunctionName("AKVSQLRotation")]
   public static void Run([EventGridTrigger]EventGridEvent eventGridEvent, ILogger log)
   {
      log.LogInformation("C# Event trigger function processed a request.");
      var secretName = eventGridEvent.Subject;
      var secretVersion = Regex.Match(eventGridEvent.Data.ToString(), "Version\":\"([a-z0-9]*)").Groups[1].ToString();
      var keyVaultName = Regex.Match(eventGridEvent.Topic, ".vaults.(.*)").Groups[1].ToString();
      log.LogInformation($"Key Vault Name: {keyVaultName}");
      log.LogInformation($"Secret Name: {secretName}");
      log.LogInformation($"Secret Version: {secretVersion}");

      SecretRotator.RotateSecret(log, secretName, keyVaultName);
   }
}

机密轮换逻辑

此轮换方法从机密中读取数据库信息,创建机密的新版本,并使用新机密更新数据库:

    public class SecretRotator
    {
		private const string CredentialIdTag = "CredentialId";
		private const string ProviderAddressTag = "ProviderAddress";
		private const string ValidityPeriodDaysTag = "ValidityPeriodDays";

		public static void RotateSecret(ILogger log, string secretName, string keyVaultName)
        {
            //Retrieve Current Secret
            var kvUri = "https://" + keyVaultName + ".vault.azure.cn";
            var client = new SecretClient(new Uri(kvUri), new DefaultAzureCredential());
            KeyVaultSecret secret = client.GetSecret(secretName);
            log.LogInformation("Secret Info Retrieved");

            //Retrieve Secret Info
            var credentialId = secret.Properties.Tags.ContainsKey(CredentialIdTag) ? secret.Properties.Tags[CredentialIdTag] : "";
            var providerAddress = secret.Properties.Tags.ContainsKey(ProviderAddressTag) ? secret.Properties.Tags[ProviderAddressTag] : "";
            var validityPeriodDays = secret.Properties.Tags.ContainsKey(ValidityPeriodDaysTag) ? secret.Properties.Tags[ValidityPeriodDaysTag] : "";
            log.LogInformation($"Provider Address: {providerAddress}");
            log.LogInformation($"Credential Id: {credentialId}");

            //Check Service Provider connection
            CheckServiceConnection(secret);
            log.LogInformation("Service  Connection Validated");

            //Create new password
            var randomPassword = CreateRandomPassword();
            log.LogInformation("New Password Generated");

            //Add secret version with new password to Key Vault
            CreateNewSecretVersion(client, secret, randomPassword);
            log.LogInformation("New Secret Version Generated");

            //Update Service Provider with new password
            UpdateServicePassword(secret, randomPassword);
            log.LogInformation("Password Changed");
            log.LogInformation($"Secret Rotated Successfully");
        }
}

可以在 GitHub 上找到完整代码。

将机密添加到 Key Vault

设置访问策略,以向用户授予“管理机密”权限:

az keyvault set-policy --upn <email-address-of-user> --name akvrotation-kv --secret-permissions set delete get list

使用包含 SQL Server 资源 ID、SQL Server 登录名和机密有效期(以天为单位)的标记创建一个新机密。 提供机密名称和 SQL 数据库中的初始密码(在我们的示例中为“Simple123”),并包含一个设置为明天的到期日期。

$tomorrowDate = (get-date).AddDays(+1).ToString("yyy-MM-ddThh:mm:ssZ")
az keyvault secret set --name sqlPassword --vault-name akvrotation-kv --value "Simple123" --tags "CredentialId=sqlAdmin" "ProviderAddress=<sql-database-resource-id>" "ValidityPeriodDays=90" --expires $tomorrowDate

创建到期日期较短的机密会在 15 分钟内发布 SecretNearExpiry 事件,而该事件又会触发函数来轮换该机密。

测试和验证

若要验证该机密是否已轮换,请转到“Key Vault”>“机密”:

Screenshot that shows how to access Key Vault > Secrets.

打开“sqlPassword”机密并查看原始版本和轮换后的版本:

Go to Secrets

创建 Web 应用

若要验证 SQL 凭据,请创建一个 Web 应用。 此 Web 应用将从 Key Vault 获取机密,从机密中提取 SQL 数据库信息和凭据,然后测试与 SQL Server 的连接。

该 Web 应用需要以下组件:

  • 一个使用系统托管标识的 Web 应用
  • 一个用于通过 Web 应用托管标识访问 Key Vault 中的机密的访问策略
  1. 选择 Azure 模板部署链接:

    Image showing a button labeled

  2. 选择“akvrotation”资源组。

  3. 在“Sql Server 名称”中,键入密码需进行轮替的 Sql Server 名称

  4. 在“密钥保管库名称”中,键入密钥保管库名称

  5. 在“机密名称”中,键入将在其中存储密码的机密名称

  6. 在“存储库 Url”中,键入 Web 应用代码 GitHub 位置 (https://github.com/Azure-Samples/KeyVault-Rotation-SQLPassword-Csharp-WebApp.git)

  7. 选择“查看 + 创建”。

  8. 选择“创建”。

打开 Web 应用

转到部署的应用程序 URL:

https://akvrotation-app.azurewebsites.net/

当应用程序在浏览器中打开时,你会看到“生成的机密值”,并会看到“数据库已连接”的值为“true”。

了解详细信息