빠른 시작 - .NET용 Azure Key Vault 키 클라이언트 라이브러리

.NET용 Azure Key Vault 키 클라이언트 라이브러리를 시작합니다. Azure Key Vault는 암호화 키에 대한 보안 저장소를 제공하는 클라우드 서비스입니다. 암호화 키, 암호, 인증서 및 기타 비밀을 안전하게 저장할 수 있습니다. Azure Portal을 통해 Azure Key Vault를 만들고 관리할 수 있습니다. 이 빠른 시작에서는 .NET 키 클라이언트 라이브러리를 사용하여 Azure Key Vault에서 키를 만들고, 검색하고, 삭제하는 방법을 알아봅니다.

Key Vault 키 클라이언트 라이브러리 리소스:

API 참조 설명서 | 라이브러리 소스 코드 | 패키지(NuGet)

Key Vault 및 키에 대한 자세한 내용은 다음을 참조하세요.

• Key Vault 개요
• 키 개요.

필수 조건

• Azure 구독 - 체험 구독 만들기
• .NET 6 SDK 이상
• Azure CLI
• Key Vault - Azure Portal, Azure CLI 또는 Azure PowerShell을 사용하여 만들 수 있습니다.

이 빠른 시작에서는 dotnet 및 Azure CLI를 사용합니다.

설정

이 빠른 시작에서는 Azure CLI와 함께 Azure ID 라이브러리를 사용하여 사용자를 Azure Services에 인증합니다. 개발자는 Visual Studio 또는 Visual Studio Code를 사용하여 해당 호출을 인증할 수도 있습니다. 자세한 내용은 Azure ID 클라이언트 라이브러리를 사용하여 클라이언트 인증을 참조하세요.

Azure에 로그인

1. login 명령을 실행합니다.

   az login
   

   CLI는 기본 브라우저를 열 수 있으면 기본 브라우저를 열고 Azure 로그인 페이지를 로드합니다.

   그렇지 않으면 https://aka.ms/devicelogin 에서 브라우저 페이지를 열고 터미널에 표시된 권한 부여 코드를 입력합니다.

2. 브라우저에서 계정 자격 증명으로 로그인합니다.

키 자격 증명 모음에 대한 액세스 권한 부여

Azure CLI

RBAC(역할 기반 액세스 제어)를 통해 키 자격 증명 모음에 애플리케이션 권한을 부여하려면 az role assignment create Azure CLI 명령을 사용하여 역할을 할당합니다.

az role assignment create --role "Key Vault Secrets User" --assignee "<app-id>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"

Azure PowerShell

RBAC(역할 기반 액세스 제어)를 통해 키 자격 증명 모음에 애플리케이션 권한을 부여하려면 Azure PowerShell cmdlet New-AzRoleAssignment를 사용하여 역할을 할당합니다.

New-AzRoleAssignment -ObjectId "<app-id>" -RoleDefinitionName "Key Vault Secrets User" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"

<app-id>, <subscription-id>, <resource-group-name>, <unique-keyvault-name>를 실제 값으로 대체합니다. <앱 ID> Azure AD에 등록된 애플리케이션의 애플리케이션(클라이언트) ID입니다.

새 .NET 콘솔 앱 만들기

1. 명령 셸에서 다음 명령을 실행하여 key-vault-console-app이라는 이름의 프로젝트를 만듭니다.

   dotnet new console --name key-vault-console-app
   

2. 새로 만든 key-vault-console-app 디렉터리로 변경하고, 다음 명령을 실행하여 프로젝트를 빌드합니다.

   dotnet build
   

   빌드 출력에 경고나 오류가 포함되지 않아야 합니다.

   Build succeeded.
    0 Warning(s)
    0 Error(s)
   

패키지 설치

명령 셸에서 .NET용 Azure Key Vault 키 클라이언트 라이브러리를 설치합니다.

dotnet add package Azure.Security.KeyVault.Keys

이 빠른 시작에서는 Azure ID 클라이언트 라이브러리도 설치해야 합니다.

dotnet add package Azure.Identity

환경 변수 설정

이 애플리케이션은 키 자격 증명 모음 이름을 KEY_VAULT_NAME이라는 환경 변수로 사용합니다.

Windows

set KEY_VAULT_NAME=<your-key-vault-name>

Windows PowerShell

$Env:KEY_VAULT_NAME="<your-key-vault-name>"

macOS 또는 Linux

export KEY_VAULT_NAME=<your-key-vault-name>

개체 모델

.NET용 Azure Key Vault 키 클라이언트 라이브러리를 사용하면 키를 관리할 수 있습니다. 코드 예제 섹션에서는 클라이언트를 만들고, 키를 설정하고, 키를 검색하고, 키를 삭제하는 방법을 보여줍니다.

코드 예제

지시문 추가

다음 지시문을 Program.cs의 위쪽에 추가합니다.

using System;
using Azure.Identity;
using Azure.Security.KeyVault.Keys;

클라이언트 인증 및 만들기

대부분의 Azure 서비스에 대한 애플리케이션 요청은 승인되어야 합니다. Azure.Identity 클라이언트 라이브러리에서 제공하는 DefaultAzureCredential 클래스를 사용하는 것은 코드에서 Azure 서비스에 대한 암호 없는 연결을 구현하는 데 권장되는 접근 방식입니다. DefaultAzureCredential은 여러 인증 방법을 지원하고 런타임에 사용해야 하는 방법을 결정합니다. 이 방법을 사용하면 앱에서 환경별 코드를 구현하지 않고도 다양한 환경(로컬 및 프로덕션)에서 다양한 인증 방법을 사용할 수 있습니다.

이 빠른 시작에서 DefaultAzureCredential은 Azure CLI에 로그인한 로컬 개발 사용자의 자격 증명을 사용하여 키 자격 증명 모음에 인증합니다. 애플리케이션이 Azure에 배포되면 동일한 DefaultAzureCredential 코드에서 App Service, 가상 머신 또는 기타 서비스에 할당된 관리 ID를 자동으로 검색하고 사용할 수 있습니다. 자세한 내용은 관리 ID 개요를 참조하세요.

이 예제에서 키 자격 증명 모음 이름은 https://<your-key-vault-name>.vault.azure.net 형식의 키 자격 증명 모음 URI로 확장됩니다. 키 자격 증명 모음 인증에 대한 자세한 내용은 개발자 가이드를 참조하세요.

var keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");
var kvUri = $"https://{keyVaultName}.vault.azure.net";

var client = new KeyClient(new Uri(kvUri), new DefaultAzureCredential());

키 저장

이 작업에는 CreateKeyAsync 메서드를 사용합니다. 메서드의 매개 변수는 키 이름과 키 형식을 받아들입니다.

var key = await client.CreateKeyAsync("myKey", KeyType.Rsa);

참고 항목

키 이름이 있는 경우 이의 코드에서 해당 키의 새 버전을 만듭니다.

키 검색

이제 GetKeyAsync 메서드를 사용하여 이전에 만든 키를 검색할 수 있습니다.

var key = await client.GetKeyAsync("myKey");

키 삭제

마지막으로 StartDeleteKeyAsync 및 PurgeDeletedKeyAsync 메서드를 사용하여 키 자격 증명 모음에서 키를 삭제하고 제거하겠습니다.

var operation = await client.StartDeleteKeyAsync("myKey");

// You only need to wait for completion if you want to purge or recover the key.
await operation.WaitForCompletionAsync();

var key = operation.Value;
await client.PurgeDeletedKeyAsync("myKey");

샘플 코드

다음 단계를 완료하여 Key Vault와 상호 작용하도록 .NET 콘솔 앱을 수정합니다.

• Program.cs의 코드를 다음 코드로 바꿉니다.

  using System;
  using System.Threading.Tasks;
  using Azure.Identity;
  using Azure.Security.KeyVault.Keys;
  
  namespace key_vault_console_app
  {
      class Program
      {
          static async Task Main(string[] args)
          {
              const string keyName = "myKey";
              var keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");
              var kvUri = $"https://{keyVaultName}.vault.azure.net";
  
              var client = new KeyClient(new Uri(kvUri), new DefaultAzureCredential());
  
              Console.Write($"Creating a key in {keyVaultName} called '{keyName}' ...");
              var createdKey = await client.CreateKeyAsync(keyName, KeyType.Rsa);
              Console.WriteLine("done.");
  
              Console.WriteLine($"Retrieving your key from {keyVaultName}.");
              var key = await client.GetKeyAsync(keyName);
              Console.WriteLine($"Your key version is '{key.Value.Properties.Version}'.");
  
              Console.Write($"Deleting your key from {keyVaultName} ...");
              var deleteOperation = await client.StartDeleteKeyAsync(keyName);
              // You only need to wait for completion if you want to purge or recover the key.
              await deleteOperation.WaitForCompletionAsync();
              Console.WriteLine("done.");
  
              Console.Write($"Purging your key from {keyVaultName} ...");
              await client.PurgeDeletedKeyAsync(keyName);
              Console.WriteLine(" done.");
          }
      }
  }
  

테스트 및 확인

1. 다음 명령을 실행하여 프로젝트를 빌드합니다.

   dotnet build
   

2. 다음 명령을 실행하여 앱을 실행합니다.

   dotnet run
   

3. 메시지가 표시되면 비밀 값을 입력합니다. 예를 들어 mySecretPassword입니다.

   다음과 유사한 출력이 표시됩니다.

   Creating a key in mykeyvault called 'myKey' ... done.
   Retrieving your key from mykeyvault.
   Your key version is '8532359bced24e4bb2525f2d2050738a'.
   Deleting your key from jl-kv ... done
   Purging your key from <your-unique-keyvault-name> ... done.   
   

다음 단계

이 빠른 시작에서는 키 자격 증명 모음을 만들고, 키를 저장하고, 해당 키를 검색했습니다.

Key Vault 및 이를 앱과 통합하는 방법에 대해 자세히 알아보려면 다음 문서를 참조하세요.

• Azure Key Vault 개요 참조
• 키 개요 읽기
• App Service 애플리케이션에서 Key Vault 액세스 자습서 참조
• Virtual Machine에서 Key Vault 액세스 자습서 참조
• Azure Key Vault 개발자 가이드 참조
• Azure Key Vault 보안 개요를 검토하세요.