Rychlý start: Klientská knihovna tajných klíčů služby Azure Key Vault pro Python

  • Článek

Začínáme s klientskou knihovnou tajných klíčů 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í tajných kódů se vyhnete ukládání tajných kódů do kódu, což zvyšuje zabezpečení aplikace.

Referenční dokumentace k | rozhraní API – Balíček zdrojového kódu | knihovny (index balíčků Pythonu)

Požadavky

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í

Tento rychlý start používá knihovnu Azure Identity s Azure CLI nebo Azure PowerShellem k ověření uživatele ve službách Azure. Vývojáři můžou také k ověřování 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ášení k Azure

  1. Spusťte příkaz az login.

    az login

    Pokud rozhraní příkazového řádku může otevřít výchozí prohlížeč, provede to a načte přihlašovací stránku Azure.

    V opačném případě otevřete stránku https://aka.ms/devicelogin prohlížeče a zadejte autorizační kód zobrazený v 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 knihovnu tajných kódů služby Key Vault:

    pip install azure-keyvault-secrets

Vytvoření skupiny prostředků a trezoru 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 nejbližší místo.

  2. Slouží 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> ho jedinečným názvem ve všech Azure. Obvykle používáte svůj osobní název nebo název společnosti spolu s dalšími čísly a identifikátory.

Nastavení proměnné 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 aplikaci udělit oprávnění k trezoru klíčů prostřednictvím řízení přístupu na základě role (RBAC), přiřaďte roli pomocí příkazu Azure CLI az role assignment create.

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>"

Nahraďte <id> aplikace, <id předplatného>, <název> skupiny prostředků a <název_jedinečné-keyvault-name> skutečnými hodnotami. <> id aplikace je ID aplikace (klienta) vaší registrované aplikace v Azure AD.

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

Klientská knihovna tajných kódů služby Azure Key Vault pro Python umožňuje spravovat tajné kódy. Následující ukázka kódu ukazuje, jak vytvořit klienta, nastavit tajný klíč, načíst tajný klíč a odstranit tajný klíč.

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

import os
from azure.keyvault.secrets import SecretClient
from azure.identity import DefaultAzureCredential

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

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

secretName = input("Input a name for your secret > ")
secretValue = input("Input a value for your secret > ")

print(f"Creating a secret in {keyVaultName} called '{secretName}' with the value '{secretValue}' ...")

client.set_secret(secretName, secretValue)

print(" done.")

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

retrieved_secret = client.get_secret(secretName)

print(f"Your secret is '{retrieved_secret.value}'.")
print(f"Deleting your secret from {keyVaultName} ...")

poller = client.begin_delete_secret(secretName)
deleted_secret = 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_secrets.py. Pak kód spusťte pomocí následujícího příkazu:

python kv_secrets.py
  • Pokud dojde k chybám oprávnění, ujistěte se, že jste spustili az keyvault set-policy příkaz nebo Set-AzKeyVaultAccessPolicy příkaz.
  • Opětovné spuštění kódu se stejným názvem tajného kódu může způsobit chybu "(Konflikt) Název> tajného <kódu je aktuálně v odstraněném, ale obnovitelném stavu." Použijte jiný název tajného kódu.

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 tomto rychlém startu DefaultAzureCredential se ověří v trezoru klíčů pomocí přihlašovacích údajů místního vývojového uživatele přihlášeného 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 trezoru klíčů rozšíří pomocí hodnoty KVUri proměnné ve formátu "https://< your-key-vault-name.vault.azure.net>".

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

Uložení tajného kódu

Po získání objektu klienta pro trezor klíčů můžete tajný kód uložit pomocí metody set_secret :

client.set_secret(secretName, secretValue)

Volání set_secret vygeneruje volání rozhraní Azure REST API pro trezor klíčů.

Když Azure požadavek zpracuje, ověří identitu volajícího (instanční objekt) pomocí objektu přihlašovacích údajů, který jste zadali klientovi.

Načtení tajného kódu

Ke čtení tajného kódu ze služby Key Vault použijte metodu get_secret :

retrieved_secret = client.get_secret(secretName)

Hodnota tajného kódu je obsažena v retrieved_secret.value.

Tajný kód můžete načíst také pomocí příkazu Azure CLI az keyvault secret show nebo rutiny Azure PowerShellu Get-AzKeyVaultSecret.

Odstranění tajného kódu

K odstranění tajného kódu použijte metodu begin_delete_secret :

poller = client.begin_delete_secret(secretName)
deleted_secret = poller.result()

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

Tajný kód jste odebrali pomocí příkazu Azure CLI az keyvault secret show nebo rutiny Azure PowerShellu Get-AzKeyVaultSecret.

Po odstranění zůstane tajný klíč po dobu odstraněný, ale obnovitelný. Pokud kód spustíte znovu, použijte jiný název tajného kódu.

Vyčištění prostředků

Pokud chcete také experimentovat s certifikáty 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