Sdílet prostřednictvím

Rychlý start: Klientská knihovna certifikátů služby Azure Key Vault pro Python

Začínáme s klientskou knihovnou certifikátů služby Azure Key Vault pro Python Pomocí těchto kroků nainstalujte balíček a vyzkoušejte si ukázkový kód pro základní úlohy. Použitím služby Key Vault k ukládání certifikátů se vyhnete ukládání certifikátů v kódu, což zvyšuje zabezpečení aplikace.

Referenční dokumentace | k rozhraní APIZdrojový kód | knihovnyBalíček (index balíčku Pythonu)

Prerequisites

V tomto rychlém startu se předpokládá, že používáte Azure CLI nebo Azure PowerShell v okně terminálu s Linuxem.

Nastavení místního prostředí

V tomto rychlém startu se k ověření uživatele ve službách Azure používá knihovna identit Azure s Azure CLI nebo Azure PowerShellem. Vývojáři také můžou k ověření volání použít Visual Studio nebo Visual Studio Code. Další informace najdete v tématu Ověřování klienta pomocí klientské knihovny Azure Identity.

Přihlásit se do Azure

  1. Spusťte příkaz login.

    az login

    Pokud CLI může otevřít váš výchozí prohlížeč, udělá to a načte přihlašovací stránku Azure.

    Jinak otevřete stránku v prohlížeči na https://aka.ms/devicelogin a zadejte autorizační kód zobrazený ve vašem terminálu.

  2. Přihlaste se pomocí přihlašovacích údajů vašeho účtu v prohlížeči.

Instalace balíčků

  1. V terminálu nebo příkazovém řádku vytvořte vhodnou složku projektu a pak vytvořte a aktivujte virtuální prostředí Pythonu, jak je popsáno v tématu Použití virtuálních prostředí Pythonu.

  2. Nainstalujte knihovnu identit Microsoft Entra:

    pip install azure.identity

  3. Nainstalujte klientskou knihovnu certifikátů služby Key Vault:

    pip install azure-keyvault-certificates

Vytvořte skupinu prostředků a trezor klíčů

  1. az group create Pomocí příkazu vytvořte skupinu prostředků:

    az group create --name myResourceGroup --location eastus

    Pokud chcete, můžete změnit "eastus" na místo blíže k vám.

  2. Použijte az keyvault create k vytvoření trezoru klíčů.

    az keyvault create --name <your-unique-keyvault-name> --resource-group myResourceGroup

    Nahraďte <your-unique-keyvault-name> názvem, který je jedinečný v rámci celé Azure. Obvykle používáte svůj osobní název nebo název společnosti spolu s dalšími čísly a identifikátory.

Nastavte proměnnou prostředí KEY_VAULT_NAME

Náš skript použije hodnotu přiřazenou KEY_VAULT_NAME proměnné prostředí jako název trezoru klíčů. Tuto hodnotu proto musíte nastavit pomocí následujícího příkazu:

export KEY_VAULT_NAME=<your-unique-keyvault-name>

Udělení přístupu k trezoru klíčů

Pokud chcete získat oprávnění k trezoru klíčů prostřednictvím řízení přístupu na základě role (RBAC), přiřaďte roli k hlavnímu názvu uživatele (UPN) pomocí příkazu Azure CLI az role assignment create.

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

Nahraďte <upn>, <subscription-id>, <resource-group-name> a <your-unique-keyvault-name> skutečnými hodnotami. Hlavní název uživatele (UPN) bude obvykle ve formátu e-mailové adresy (např username@domain.com. ).

Vytvoření ukázkového kódu

Klientská knihovna certifikátů služby Azure Key Vault pro Python umožňuje spravovat certifikáty. Následující ukázka kódu ukazuje, jak vytvořit klienta, nastavit certifikát, načíst certifikát a odstranit certifikát.

Vytvořte soubor s názvem kv_certificates.py , který obsahuje tento kód.

import os
from azure.keyvault.certificates import CertificateClient, CertificatePolicy
from azure.identity import DefaultAzureCredential

keyVaultName = os.environ["KEY_VAULT_NAME"]
KVUri = "https://" + keyVaultName + ".vault.azure.net"

credential = DefaultAzureCredential()
client = CertificateClient(vault_url=KVUri, credential=credential)

certificateName = input("Input a name for your certificate > ")

print(f"Creating a certificate in {keyVaultName} called '{certificateName}' ...")

policy = CertificatePolicy.get_default()
poller = client.begin_create_certificate(certificate_name=certificateName, policy=policy)
certificate = poller.result()

print(" done.")

print(f"Retrieving your certificate from {keyVaultName}.")

retrieved_certificate = client.get_certificate(certificateName)

print(f"Certificate with name '{retrieved_certificate.name}' was found'.")
print(f"Deleting your certificate from {keyVaultName} ...")

poller = client.begin_delete_certificate(certificateName)
deleted_certificate = poller.result()

print(" done.")

Spuštění kódu

Ujistěte se, že kód v předchozí části je v souboru s názvem kv_certificates.py. Pak kód spusťte pomocí následujícího příkazu:

python kv_certificates.py

Podrobnosti kódu

Ověření a vytvoření klienta

Žádosti o aplikace na většinu služeb Azure musí být autorizované. Použití defaultAzureCredential třídy poskytované klientskou knihovnou Azure Identity je doporučený postup pro implementaci připojení bez hesla ke službám Azure ve vašem kódu. DefaultAzureCredential podporuje více metod ověřování a určuje, která metoda se má použít za běhu. Tento přístup umožňuje vaší aplikaci používat různé metody ověřování v různých prostředích (místní a produkční) bez implementace kódu specifického pro prostředí.

V této rychlé příručce se DefaultAzureCredential autentizuje k úložišti klíčů pomocí přihlašovacích údajů místního vývojáře, který je přihlášený k Azure CLI. Když je aplikace nasazená do Azure, může stejný DefaultAzureCredential kód automaticky zjišťovat a používat spravovanou identitu přiřazenou ke službě App Service, virtuálnímu počítači nebo jiným službám. Další informace najdete v tématu Přehled spravované identity.

V ukázkovém kódu se název vašeho trezoru klíčů převede na identifikátor URI trezoru klíčů ve formátu https://\<your-key-vault-name>.vault.azure.net.

credential = DefaultAzureCredential()
client = CertificateClient(vault_url=KVUri, credential=credential)

Uložení certifikátu

Po získání objektu klienta pro trezor klíčů můžete vytvořit certifikát pomocí metody begin_create_certificate :

policy = CertificatePolicy.get_default()
poller = client.begin_create_certificate(certificate_name=certificateName, policy=policy)
certificate = poller.result()

V této části certifikát vyžaduje zásadu získanou pomocí metody CertificatePolicy.get_default .

Volání metody begin_create_certificate vygeneruje asynchronní volání Azure REST API pro klíčový trezor. Asynchronní volání vrátí objekt poller (pollovací objekt). Pokud chcete počkat na výsledek operace, zavolejte metodu „poller“.result

Když Azure zpracovává požadavek, ověří identitu volajícího (servisní principál) pomocí objektu přihlašovacích údajů, který jste poskytli klientovi.

Získejte certifikát

Ke čtení certifikátu ze služby Key Vault použijte metodu get_certificate :

retrieved_certificate = client.get_certificate(certificateName)

Certifikát můžete také ověřit pomocí příkazu Azure CLI az keyvault certificate show nebo rutiny Azure PowerShellu Get-AzKeyVaultCertificate.

Odstranění certifikátu

K odstranění certifikátu použijte metodu begin_delete_certificate :

poller = client.begin_delete_certificate(certificateName)
deleted_certificate = poller.result()

Metoda begin_delete_certificate je asynchronní a vrací objekt poller. Volání metody poller result čeká na jeho dokončení.

Můžete ověřit, že byl certifikát odstraněn, pomocí příkazu Azure CLI az keyvault certificate show nebo rutiny Azure PowerShellu Get-AzKeyVaultCertificate.

Po odstranění zůstane certifikát po dobu odstraněný, ale obnovitelný. Pokud kód spustíte znovu, použijte jiný název certifikátu.

Vyčistěte zdroje

Pokud chcete také experimentovat s tajnými kódy a klíči, můžete znovu použít službu Key Vault vytvořenou v tomto článku.

Jinak po dokončení práce s prostředky vytvořenými v tomto článku odstraňte skupinu prostředků a všechny její obsažené prostředky pomocí následujícího příkazu:

az group delete --resource-group myResourceGroup

Další kroky

  • Last updated on