[Key Vault] Add certificate import sample (#20641)

sdk/keyvault/azure-keyvault-certificates/samples/README.md

@@ -15,6 +15,8 @@ These code snippets highlight this SDK's common use cases.
 * [hello_world.py][hello_world_sample] and [hello_world_async.py][hello_world_async_sample] - create/get/update/delete certificates
 * [backup_restore_operations.py][backup_operations_sample] and [backup_restore_operations_async.py][backup_operations_async_sample] - backup and
 recover certificates
+* [import_certificate.py][import_certificate_sample] and [import_certificate_async.py][import_certificate_async_sample] - import PKCS#12 (PFX)
+and PEM-formatted certificates into Key Vault
 * [list_operations.py][list_operations_sample] and [list_operations_async.py][list_operations_async_sample] - list certificates
 * [recover_purge_operations.py][recover_purge_operations_sample] and [recover_purge_operations_async.py][recover_purge_operations_async_sample] - recover and purge certificates
 * [issuers.py][issuers_sample] and [issuers_async.py][issuers_async_sample] - manage certificate issuers
@@ -25,6 +27,8 @@ recover certificates
 [backup_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-certificates/samples/backup_restore_operations_async.py
 [hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/azure-keyvault-certificates/samples/hello_world.py
 [hello_world_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/azure-keyvault-certificates/samples/hello_world_async.py
+[import_certificate_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-certificates/samples/import_certificate.py
+[import_certificate_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-certificates/samples/import_certificate_async.py
 [keyvault_docs]: https://docs.microsoft.com/azure/key-vault/
 [list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/azure-keyvault-certificates/samples/list_operations.py
 [list_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/azure-keyvault-certificates/samples/list_operations_async.py

sdk/keyvault/azure-keyvault-certificates/samples/import_certificate.py

@@ -0,0 +1,64 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+import os
+from azure.identity import DefaultAzureCredential
+from azure.keyvault.certificates import (
+    CertificateClient,
+    CertificateContentType,
+    CertificatePolicy,
+    WellKnownIssuerNames,
+)
+
+# ----------------------------------------------------------------------------------------------------------
+# Prerequisites:
+# 1. An Azure Key Vault (https://docs.microsoft.com/en-us/azure/key-vault/quick-create-cli)
+#
+# 2. azure-keyvault-certificates and azure-identity packages (pip install these)
+#
+# 3. Set up your environment to use azure-identity's DefaultAzureCredential. To authenticate a service principal with
+#    environment variables, set AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, and AZURE_TENANT_ID
+#    (See https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-administration#authenticate-the-client)
+#
+# 4. A PFX certificate on your machine. Set an environment variable, PFX_CERT_PATH, with the path to this certificate.
+#
+# 5. A PEM-formatted certificate on your machine. Set an environment variable, PEM_CERT_PATH, with the path to this
+#    certificate.
+#
+# ----------------------------------------------------------------------------------------------------------
+# Sample - demonstrates importing a PFX and PEM-formatted certificate into Azure Key Vault
+#
+# 1. Import an existing PFX certificate (import_certificate)
+#
+# 2. Import an existing PEM-formatted certificate (import_certificate)
+#
+# ----------------------------------------------------------------------------------------------------------
+
+# Instantiate a certificate client that will be used to call the service.
+# Here we use the DefaultAzureCredential, but any azure-identity credential can be used.
+VAULT_URL = os.environ["VAULT_URL"]
+credential = DefaultAzureCredential()
+client = CertificateClient(vault_url=VAULT_URL, credential=credential)
+
+# Let's import a PFX certificate first.
+# Assuming you already have a PFX containing your key pair, you can import it into Key Vault.
+# You can do this without setting a policy, but the policy is needed if you want the private key to be exportable
+# or to configure actions when a certificate is close to expiration.
+pfx_cert_name = "pfxCert"
+with open(os.environ["PFX_CERT_PATH"], "rb") as f:
+    pfx_cert_bytes = f.read()
+imported_pfx_cert = client.import_certificate(certificate_name=pfx_cert_name, certificate_bytes=pfx_cert_bytes)
+print("PFX certificate '{}' imported successfully.".format(imported_pfx_cert.name))
+
+# Now let's import a PEM-formatted certificate.
+# To import a PEM-formatted certificate, you must provide a CertificatePolicy that sets the content_type to
+# CertificateContentType.pem or the certificate will fail to import (the default content type is PFX).
+pem_cert_name = "pemCert"
+with open(os.environ["PEM_CERT_PATH"], "rb") as f:
+    pem_cert_bytes = f.read()
+pem_cert_policy = CertificatePolicy(issuer_name=WellKnownIssuerNames.self, content_type=CertificateContentType.pem)
+imported_pem_cert = client.import_certificate(
+    certificate_name=pem_cert_name, certificate_bytes=pem_cert_bytes, policy=pem_cert_policy
+)
+print("PEM-formatted certificate '{}' imported successfully.".format(imported_pem_cert.name))

sdk/keyvault/azure-keyvault-certificates/samples/import_certificate_async.py

@@ -0,0 +1,72 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+import asyncio
+import os
+from azure.identity.aio import DefaultAzureCredential
+from azure.keyvault.certificates import CertificateContentType, CertificatePolicy, WellKnownIssuerNames
+from azure.keyvault.certificates.aio import CertificateClient
+
+# ----------------------------------------------------------------------------------------------------------
+# Prerequisites:
+# 1. An Azure Key Vault (https://docs.microsoft.com/en-us/azure/key-vault/quick-create-cli)
+#
+# 2. azure-keyvault-certificates and azure-identity packages (pip install these)
+#
+# 3. Set up your environment to use azure-identity's DefaultAzureCredential. To authenticate a service principal with
+#    environment variables, set AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, and AZURE_TENANT_ID
+#    (See https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-administration#authenticate-the-client)
+#
+# 4. A PFX certificate on your machine. Set an environment variable, PFX_CERT_PATH, with the path to this certificate.
+#
+# 5. A PEM-formatted certificate on your machine. Set an environment variable, PEM_CERT_PATH, with the path to this
+#    certificate.
+#
+# ----------------------------------------------------------------------------------------------------------
+# Sample - demonstrates importing a PFX and PEM-formatted certificate into Azure Key Vault
+#
+# 1. Import an existing PFX certificate (import_certificate)
+#
+# 2. Import an existing PEM-formatted certificate (import_certificate)
+#
+# ----------------------------------------------------------------------------------------------------------
+
+async def run_sample():
+    # Instantiate a certificate client that will be used to call the service.
+    # Here we use the DefaultAzureCredential, but any azure-identity credential can be used.
+    VAULT_URL = os.environ["VAULT_URL"]
+    credential = DefaultAzureCredential()
+    client = CertificateClient(vault_url=VAULT_URL, credential=credential)
+
+    # Let's import a PFX certificate first.
+    # Assuming you already have a PFX containing your key pair, you can import it into Key Vault.
+    # You can do this without setting a policy, but the policy is needed if you want the private key to be exportable
+    # or to configure actions when a certificate is close to expiration.
+    pfx_cert_name = "pfxCert"
+    with open(os.environ["PFX_CERT_PATH"], "rb") as f:
+        pfx_cert_bytes = f.read()
+    imported_pfx_cert = await client.import_certificate(
+        certificate_name=pfx_cert_name, certificate_bytes=pfx_cert_bytes
+    )
+    print("PFX certificate '{}' imported successfully.".format(imported_pfx_cert.name))
+
+    # Now let's import a PEM-formatted certificate.
+    # To import a PEM-formatted certificate, you must provide a CertificatePolicy that sets the content_type to
+    # CertificateContentType.pem or the certificate will fail to import (the default content type is PFX).
+    pem_cert_name = "pemCert"
+    with open(os.environ["PEM_CERT_PATH"], "rb") as f:
+        pem_cert_bytes = f.read()
+    pem_cert_policy = CertificatePolicy(issuer_name=WellKnownIssuerNames.self, content_type=CertificateContentType.pem)
+    imported_pem_cert = await client.import_certificate(
+        certificate_name=pem_cert_name, certificate_bytes=pem_cert_bytes, policy=pem_cert_policy
+    )
+    print("PEM-formatted certificate '{}' imported successfully.".format(imported_pem_cert.name))
+
+    await credential.close()
+    await client.close()
+
+if __name__ == "__main__":
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(run_sample())
+    loop.close()