Szybki start: Azure Key Vault klienta certyfikatu dla platformy .NET (ZESTAW SDK 4)

Wprowadzenie do biblioteki klienta Azure Key Vault certyfikatów dla programu .NET. Azure Key Vault to usługa w chmurze, która zapewnia bezpieczny magazyn certyfikatów. Możesz bezpiecznie przechowywać klucze, hasła, certyfikaty oraz inne wpisy tajne. Magazyny kluczy platformy Azure można tworzyć oraz nimi zarządzać za pośrednictwem witryny Azure Portal. Z tego przewodnika Szybki start dowiesz się, jak tworzyć, pobierać i usuwać certyfikaty z usługi Azure Key Vault przy użyciu biblioteki klienta platformy .NET

Key Vault zasobów biblioteki klienta:

Dokumentacja referencyjna interfejsu API | Kod źródłowy biblioteki | Pakiet (NuGet)

Aby uzyskać więcej informacji Key Vault i certyfikatów, zobacz:

Wymagania wstępne

Ten przewodnik Szybki start korzysta z interfejsu dotnet wiersza polecenia platformy Azure

Konfigurowanie

Ten przewodnik Szybki start używa biblioteki tożsamości platformy Azure z interfejsem wiersza polecenia platformy Azure do uwierzytelniania użytkownika w usługach platformy Azure. Deweloperzy mogą również używać Visual Studio lub Visual Studio Code do uwierzytelniania swoich wywołań. Aby uzyskać więcej informacji, zobacz Authenticate the client with Azure Identity client library (Uwierzytelnianie klienta za pomocą biblioteki klienta tożsamości platformy Azure).

Logowanie do platformy Azure

  1. Uruchom polecenie login.

    az login
    

    Jeśli interfejs wiersza polecenia może otworzyć domyślną przeglądarkę, zrobi to i załaduje stronę logowania platformy Azure.

    W przeciwnym razie otwórz stronę przeglądarki pod https://aka.ms/devicelogin adresem i wprowadź kod autoryzacji wyświetlany w terminalu.

  2. Zaloguj się w przeglądarce przy użyciu poświadczeń swojego konta.

Udzielanie dostępu do magazynu kluczy

Utwórz zasady dostępu dla magazynu kluczy, które będą udzielać uprawnień do certyfikatu kontu użytkownika

az keyvault set-policy --name <your-key-vault-name> --upn user@domain.com --certificate-permissions delete get list create purge

Tworzenie nowej aplikacji konsolowej .NET

  1. W powłoki poleceń uruchom następujące polecenie, aby utworzyć projekt o nazwie key-vault-console-app :

    dotnet new console --name key-vault-console-app
    
  2. Zmień katalog na nowo utworzony katalog key-vault-console-app i uruchom następujące polecenie, aby skompilować projekt:

    dotnet build
    

    Dane wyjściowe kompilacji nie powinny zawierać ostrzeżeń ani błędów.

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

Instalowanie pakietów

Z powłoki poleceń zainstaluj bibliotekę klienta Azure Key Vault certyfikatu dla programu .NET:

dotnet add package Azure.Security.KeyVault.Certificates

W tym przewodniku Szybki start musisz również zainstalować bibliotekę klienta zestawu Azure SDK dla tożsamości platformy Azure:

dotnet add package Azure.Identity

Ustawianie zmiennych środowiskowych

Ta aplikacja używa nazwy magazynu kluczy jako zmiennej środowiskowej o nazwie KEY_VAULT_NAME .

Windows

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

Windows PowerShell

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

macOS lub Linux

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

Model obiektu

Biblioteka Azure Key Vault klienta certyfikatów dla programu .NET umożliwia zarządzanie certyfikatami. W sekcji Przykłady kodu pokazano, jak utworzyć klienta, ustawić certyfikat, pobrać certyfikat i usunąć certyfikat.

Przykłady kodu

Dodawanie dyrektyw

Dodaj następujące dyrektywy na początku programu Program.cs:

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

Uwierzytelnianie i tworzenie klienta

W tym przewodniku Szybki start zalogowany użytkownik jest używany do uwierzytelniania w magazynie kluczy, co jest preferowaną metodą tworzenia aplikacji lokalnych. W przypadku aplikacji wdrożonych na platformie Azure tożsamość zarządzana powinna zostać przypisana do usługi App Service lub maszyny wirtualnej. Aby uzyskać więcej informacji, zobacz Omówienie tożsamości zarządzanej.

W poniższym przykładzie nazwa magazynu kluczy jest rozszerzana do wartości URI magazynu kluczy w formacie "https:// <your-key-vault-name> .vault.azure.net". W tym przykładzie jest to klasa "DefaultAzureCredential()" z biblioteki tożsamości platformy Azure,która umożliwia używanie tego samego kodu w różnych środowiskach z różnymi opcjami w celu zapewnienia tożsamości. Aby uzyskać więcej informacji na temat uwierzytelniania w magazynie kluczy, zobacz Developer's Guide (Przewodnik dewelopera).

string keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");
var kvUri = "https://" + keyVaultName + ".vault.azure.net";

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

Zapisywanie certyfikatu

W tym przykładzie dla uproszczenia można użyć certyfikatu z podpisem własnym z domyślnymi zasadami wystawiania. W tym zadaniu użyj metody StartCreateCertificateAsync. Parametry metody akceptują nazwę certyfikatu i zasady certyfikatu.

var operation = await client.StartCreateCertificateAsync("myCertificate", CertificatePolicy.Default);
var certificate = await operation.WaitForCompletionAsync();

Uwaga

Jeśli nazwa certyfikatu istnieje, powyższy kod utworzy nową wersję tego certyfikatu.

Pobieranie certyfikatu

Możesz teraz pobrać wcześniej utworzony certyfikat za pomocą metody GetCertificateAsync.

var certificate = await client.GetCertificateAsync("myCertificate");

Usuwanie certyfikatu

Na koniec usuńmy i przeczyścimy certyfikat z magazynu kluczy za pomocą metod StartDeleteCertificateAsync i PurgeDeletedCertificateAsync.

var operation = await client.StartDeleteCertificateAsync("myCertificate");

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

var certificate = operation.Value;
await client.PurgeDeletedCertificateAsync("myCertificate");

Przykładowy kod

Zmodyfikuj aplikację konsolą .NET Core, aby wchodzić w Key Vault, wykonując następujące czynności:

  • Zastąp kod w pliku Program.cs następującym kodem:

    using System;
    using System.Threading.Tasks;
    using Azure.Identity;
    using Azure.Security.KeyVault.Certificates;
    
    namespace key_vault_console_app
    {
        class Program
        {
            static async Task Main(string[] args)
            {
                const string certificateName = "myCertificate";
                var keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");
                var kvUri = $"https://{keyVaultName}.vault.azure.net";
    
                var client = new CertificateClient(new Uri(kvUri), new DefaultAzureCredential());
    
                Console.Write($"Creating a certificate in {keyVaultName} called '{certificateName}' ...");
                CertificateOperation operation = await client.StartCreateCertificateAsync(certificateName, CertificatePolicy.Default);
                await operation.WaitForCompletionAsync();
                Console.WriteLine(" done.");
    
                Console.WriteLine($"Retrieving your certificate from {keyVaultName}.");
                var certificate = await client.GetCertificateAsync(certificateName);
                Console.WriteLine($"Your certificate version is '{certificate.Value.Properties.Version}'.");
    
                Console.Write($"Deleting your certificate from {keyVaultName} ...");
                DeleteCertificateOperation deleteOperation = await client.StartDeleteCertificateAsync(certificateName);
                // You only need to wait for completion if you want to purge or recover the certificate.
                await deleteOperation.WaitForCompletionAsync();
                Console.WriteLine(" done.");
    
                Console.Write($"Purging your certificate from {keyVaultName} ...");
                await client.PurgeDeletedCertificateAsync(certificateName);
                Console.WriteLine(" done.");
            }
        }
    }
    

Testowanie i weryfikowanie

Wykonaj następujące polecenie, aby skompilować projekt

dotnet build

Zostanie wyświetlona odmiana następujących danych wyjściowych:

Creating a certificate in mykeyvault called 'myCertificate' ... done.
Retrieving your certificate from mykeyvault.
Your certificate version is '8532359bced24e4bb2525f2d2050738a'.
Deleting your certificate from mykeyvault ... done
Purging your certificate from mykeyvault ... done

Następne kroki

W tym przewodniku Szybki start utworzono magazyn kluczy, przechowywano certyfikat i pobrano ten certyfikat.

Aby dowiedzieć się więcej Key Vault o tym, jak zintegrować ją z aplikacjami, zobacz następujące artykuły: