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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import time
import pytest
from azure.keyvault.certificates import ApiVersion, CertificateContentType, CertificatePolicy, WellKnownIssuerNames
from devtools_testutils import recorded_by_proxy
from _shared.test_case import KeyVaultTestCase
from _test_case import CertificatesClientPreparer, get_decorator
all_api_versions = get_decorator()
exclude_2016_10_01 = get_decorator(api_versions=[v for v in ApiVersion if v != ApiVersion.V2016_10_01])
def print(*args):
assert all(arg is not None for arg in args)
@pytest.mark.playback_test_only("Can't run in live pipelines, and there's no reason to.")
def test_create_certificate_client():
vault_url = "vault_url"
# pylint:disable=unused-variable
# [START create_certificate_client]
from azure.identity import DefaultAzureCredential
from azure.keyvault.certificates import CertificateClient
# Create a CertificateClient using default Azure credentials
credential = DefaultAzureCredential()
certificate_client = CertificateClient(vault_url=vault_url, credential=credential)
# [END create_certificate_client]
class TestExamplesKeyVault(KeyVaultTestCase):
@pytest.mark.parametrize("api_version", all_api_versions)
@CertificatesClientPreparer()
@recorded_by_proxy
def test_example_certificate_crud_operations(self, certificate_client, **kwargs):
cert_name = self.get_resource_name("cert-name")
# [START create_certificate]
from azure.keyvault.certificates import CertificateContentType, CertificatePolicy, WellKnownIssuerNames
# specify the certificate policy
cert_policy = CertificatePolicy(
issuer_name=WellKnownIssuerNames.self,
subject="CN=*.microsoft.com",
san_dns_names=["sdk.azure-int.net"],
exportable=True,
key_type="RSA",
key_size=2048,
reuse_key=False,
content_type=CertificateContentType.pkcs12,
validity_in_months=24,
)
# create a certificate with optional arguments, returns a long running operation poller
certificate_operation_poller = certificate_client.begin_create_certificate(
certificate_name=cert_name, policy=cert_policy
)
# Here we are waiting for the certificate creation operation to be completed
certificate = certificate_operation_poller.result()
# You can get the final status of the certificate operation poller using .result()
print(certificate_operation_poller.result())
print(certificate.id)
print(certificate.name)
print(certificate.policy.issuer_name)
# [END create_certificate]
# [START get_certificate]
# get the certificate
certificate = certificate_client.get_certificate(cert_name)
print(certificate.id)
print(certificate.name)
print(certificate.policy.issuer_name)
# [END get_certificate]
version = certificate.properties.version
# [START get_certificate_version]
certificate = certificate_client.get_certificate_version(cert_name, version)
print(certificate.id)
print(certificate.properties.version)
# [END get_certificate_version]
# [START update_certificate]
# update attributes of an existing certificate
tags = {"foo": "updated tag"}
updated_certificate = certificate_client.update_certificate_properties(
certificate_name=certificate.name, tags=tags
)
print(updated_certificate.properties.version)
print(updated_certificate.properties.updated_on)
print(updated_certificate.properties.tags)
# [END update_certificate]
# [START delete_certificate]
# delete a certificate
deleted_certificate = certificate_client.begin_delete_certificate(certificate.name).result()
print(deleted_certificate.name)
# if the vault has soft-delete enabled, the certificate's deleted date,
# scheduled purge date, and recovery id are available
print(deleted_certificate.deleted_on)
print(deleted_certificate.scheduled_purge_date)
print(deleted_certificate.recovery_id)
# [END delete_certificate]
@pytest.mark.parametrize("api_version", all_api_versions)
@CertificatesClientPreparer()
@recorded_by_proxy
def test_example_certificate_list_operations(self, certificate_client, **kwargs):
# specify the certificate policy
cert_policy = CertificatePolicy(
issuer_name=WellKnownIssuerNames.self,
subject="CN=*.microsoft.com",
san_dns_names=["sdk.azure-int.net"],
exportable=True,
key_type="RSA",
key_size=2048,
reuse_key=False,
content_type=CertificateContentType.pkcs12,
validity_in_months=24,
)
certificate_name = self.get_resource_name("cert")
certificate_client.begin_create_certificate(certificate_name, cert_policy).wait()
# [START list_properties_of_certificates]
# get an iterator of certificates
certificates = certificate_client.list_properties_of_certificates()
for certificate in certificates:
print(certificate.id)
print(certificate.created_on)
print(certificate.name)
print(certificate.updated_on)
print(certificate.enabled)
# [END list_properties_of_certificates]
# create a second version of the cert
certificate_client.begin_create_certificate(certificate_name, cert_policy).wait()
# [START list_properties_of_certificate_versions]
# get an iterator of a certificate's versions
certificate_versions = certificate_client.list_properties_of_certificate_versions(certificate_name)
for certificate in certificate_versions:
print(certificate.id)
print(certificate.updated_on)
print(certificate.version)
# [END list_properties_of_certificate_versions]
certificate_client.begin_delete_certificate(certificate_name).wait()
# [START list_deleted_certificates]
# get an iterator of deleted certificates (requires soft-delete enabled for the vault)
deleted_certificates = certificate_client.list_deleted_certificates()
for certificate in deleted_certificates:
print(certificate.id)
print(certificate.name)
print(certificate.deleted_on)
print(certificate.scheduled_purge_date)
print(certificate.deleted_on)
# [END list_deleted_certificates]
@pytest.mark.parametrize("api_version", exclude_2016_10_01)
@CertificatesClientPreparer()
@recorded_by_proxy
def test_example_certificate_backup_restore(self, certificate_client, **kwargs):
# specify the certificate policy
cert_policy = CertificatePolicy(
issuer_name=WellKnownIssuerNames.self,
subject="CN=*.microsoft.com",
san_dns_names=["sdk.azure-int.net"],
exportable=True,
key_type="RSA",
key_size=2048,
reuse_key=False,
content_type=CertificateContentType.pkcs12,
validity_in_months=24,
)
polling_interval = 0 if self.is_playback() else None
cert_name = self.get_resource_name("cert-name")
certificate_client.begin_create_certificate(certificate_name=cert_name, policy=cert_policy).wait()
# [START backup_certificate]
# backup certificate
certificate_backup = certificate_client.backup_certificate(cert_name)
# returns the raw bytes of the backed up certificate
print(certificate_backup)
# [END backup_certificate]
certificate_client.begin_delete_certificate(certificate_name=cert_name).wait()
certificate_client.purge_deleted_certificate(certificate_name=cert_name)
if self.is_live:
time.sleep(60)
# [START restore_certificate]
# restore a certificate backup
restored_certificate = certificate_client.restore_certificate_backup(certificate_backup)
print(restored_certificate.id)
print(restored_certificate.name)
print(restored_certificate.properties.version)
# [END restore_certificate]
@pytest.mark.parametrize("api_version", all_api_versions)
@CertificatesClientPreparer()
@recorded_by_proxy
def test_example_certificate_recover(self, certificate_client, **kwargs):
# specify the certificate policy
cert_policy = CertificatePolicy(
issuer_name=WellKnownIssuerNames.self,
subject="CN=*.microsoft.com",
san_dns_names=["sdk.azure-int.net"],
exportable=True,
key_type="RSA",
key_size=2048,
reuse_key=False,
content_type=CertificateContentType.pkcs12,
validity_in_months=24,
)
cert_name = self.get_resource_name("cert-name")
polling_interval = 0 if self.is_playback() else None
certificate_client.begin_create_certificate(certificate_name=cert_name, policy=cert_policy).wait()
certificate_client.begin_delete_certificate(certificate_name=cert_name).wait()
# [START get_deleted_certificate]
# get a deleted certificate (requires soft-delete enabled for the vault)
deleted_certificate = certificate_client.get_deleted_certificate(cert_name)
print(deleted_certificate.name)
# if the vault has soft-delete enabled, the certificate's deleted date,
# scheduled purge date, and recovery id are available
print(deleted_certificate.deleted_on)
print(deleted_certificate.scheduled_purge_date)
print(deleted_certificate.recovery_id)
# [END get_deleted_certificate]
# [START recover_deleted_certificate]
# recover a deleted certificate to its latest version (requires soft-delete enabled for the vault)
recovered_certificate = certificate_client.begin_recover_deleted_certificate(cert_name).result()
print(recovered_certificate.id)
print(recovered_certificate.name)
# [END recover_deleted_certificate]
@pytest.mark.parametrize("api_version", all_api_versions)
@CertificatesClientPreparer()
@recorded_by_proxy
def test_example_contacts(self, certificate_client, **kwargs):
# [START set_contacts]
from azure.keyvault.certificates import CertificateContact
# Create a list of the contacts that you want to set for this key vault.
contact_list = [
CertificateContact(email="admin@contoso.com", name="John Doe", phone="1111111111"),
CertificateContact(email="admin2@contoso.com", name="John Doe2", phone="2222222222"),
]
contacts = certificate_client.set_contacts(contact_list)
for contact in contacts:
print(contact.name)
print(contact.email)
print(contact.phone)
# [END set_contacts]
# [START get_contacts]
contacts = certificate_client.get_contacts()
# Loop through the certificate contacts for this key vault.
for contact in contacts:
print(contact.name)
print(contact.email)
print(contact.phone)
# [END get_contacts]
# [START delete_contacts]
deleted_contacts = certificate_client.delete_contacts()
for deleted_contact in deleted_contacts:
print(deleted_contact.name)
print(deleted_contact.email)
print(deleted_contact.phone)
# [END delete_contacts]
@pytest.mark.parametrize("api_version", all_api_versions)
@CertificatesClientPreparer()
@recorded_by_proxy
def test_example_issuers(self, certificate_client, **kwargs):
# [START create_issuer]
from azure.keyvault.certificates import AdministratorContact
# First we specify the AdministratorContact for a issuer.
admin_contacts = [
AdministratorContact(first_name="John", last_name="Doe", email="admin@microsoft.com", phone="4255555555")
]
issuer = certificate_client.create_issuer(
issuer_name="issuer1",
provider="Test",
account_id="keyvaultuser",
admin_contacts=admin_contacts,
enabled=True,
)
print(issuer.name)
print(issuer.provider)
print(issuer.account_id)
for contact in issuer.admin_contacts:
print(contact.first_name)
print(contact.last_name)
print(contact.email)
print(contact.phone)
# [END create_issuer]
# [START get_issuer]
issuer = certificate_client.get_issuer("issuer1")
print(issuer.name)
print(issuer.provider)
print(issuer.account_id)
for contact in issuer.admin_contacts:
print(contact.first_name)
print(contact.last_name)
print(contact.email)
print(contact.phone)
# [END get_issuer]
certificate_client.create_issuer(
issuer_name="issuer2", provider="Test", account_id="keyvaultuser", enabled=True
)
# [START list_properties_of_issuers]
issuers = certificate_client.list_properties_of_issuers()
for issuer in issuers:
print(issuer.name)
print(issuer.provider)
# [END list_properties_of_issuers]
# [START delete_issuer]
deleted_issuer = certificate_client.delete_issuer("issuer1")
print(deleted_issuer.name)
print(deleted_issuer.provider)
print(deleted_issuer.account_id)
for contact in deleted_issuer.admin_contacts:
print(contact.first_name)
print(contact.last_name)
print(contact.email)
print(contact.phone)
# [END delete_issuer]
|