1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# pylint: disable=line-too-long,useless-suppression
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import asyncio
from json import loads
import os
from azure.keyvault.securitydomain.models import CertificateInfo, SecurityDomainJsonWebKey
# ----------------------------------------------------------------------------------------------------------
# Prerequisites:
# 1. An Azure Key Vault Managed HSM (https://learn.microsoft.com/azure/key-vault/managed-hsm/quick-create-cli)
#
# 2. Three JSON files, containing JWKs, to be used as security domain wrapping keys. Set environment variables
# SD_KEY_1, SD_KEY_2, and SD_KEY_3 to the paths of the files.
#
# 3. azure-keyvault-securitydomain and azure-identity libraries (pip install these)
#
# 4. Set environment variable VAULT_URL with the URL of your managed HSM
#
# 5. Set up your environment to use azure-identity's DefaultAzureCredential. For more information about how to configure
# the DefaultAzureCredential, refer to https://aka.ms/azsdk/python/identity/docs#azure.identity.DefaultAzureCredential
#
# ----------------------------------------------------------------------------------------------------------
# Sample - demonstrates the security domain download operations for Azure Key Vault Managed HSM
#
# 1. Download a security domain (begin_download)
# ----------------------------------------------------------------------------------------------------------
async def run_sample():
# Instantiate a security domain client that will be used to call the service.
# Here we use the DefaultAzureCredential, but any azure-identity credential can be used.
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.securitydomain.aio import SecurityDomainClient
VAULT_URL = os.environ["VAULT_URL"]
credential = DefaultAzureCredential()
client = SecurityDomainClient(vault_url=VAULT_URL, credential=credential)
# Load the JWKs into SecurityDomainJsonWebKey objects, to provide to a CertificateInfo object.
print("Preparing security domain wrapping keys.")
sd_wrapping_keys = [os.environ["SD_KEY_1"], os.environ["SD_KEY_2"], os.environ["SD_KEY_3"]]
certificates = []
for path in sd_wrapping_keys:
with open(path, "rb") as f:
jwk = loads(f.read())
certificates.append(SecurityDomainJsonWebKey(jwk))
certs_object = CertificateInfo(certificates=certificates)
# Download the security domain. Without passing `skip_activation_polling=True`, calling `.result()` on the returned
# poller will wait for HSM activation to complete. By passing the argument, the poller will return immediately with
# the security domain instead (activation status can be checked with `client.get_download_status`).
print("Beginning security domain download.")
poller = await client.begin_download(certificate_info=certs_object, skip_activation_polling=True)
security_domain = poller.result()
print("Security domain downloaded successfully.")
if __name__ == "__main__":
asyncio.run(run_sample())
|
