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 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import codecs
from dateutil import parser as date_parse
import functools
import time
import logging
import json
from azure.core.exceptions import ResourceExistsError, ResourceNotFoundError
from azure.keyvault.keys import JsonWebKey, KeyClient
from devtools_testutils import ResourceGroupPreparer, KeyVaultPreparer
from _shared.preparer import KeyVaultClientPreparer as _KeyVaultClientPreparer
from _shared.test_case import KeyVaultTestCase
# pre-apply the client_cls positional argument so it needn't be explicitly passed below
KeyVaultClientPreparer = functools.partial(_KeyVaultClientPreparer, KeyClient)
# used for logging tests
class MockHandler(logging.Handler):
def __init__(self):
super(MockHandler, self).__init__()
self.messages = []
def emit(self, record):
self.messages.append(record)
class KeyClientTests(KeyVaultTestCase):
def _assert_key_attributes_equal(self, k1, k2):
self.assertEqual(k1.name, k2.name)
self.assertEqual(k1.vault_url, k2.vault_url)
self.assertEqual(k1.enabled, k2.enabled)
self.assertEqual(k1.not_before, k2.not_before)
self.assertEqual(k1.expires_on, k2.expires_on)
self.assertEqual(k1.created_on, k2.created_on)
self.assertEqual(k1.updated_on, k2.updated_on)
self.assertEqual(k1.tags, k2.tags)
self.assertEqual(k1.recovery_level, k2.recovery_level)
def _create_rsa_key(self, client, key_name, hsm=False):
# create key with optional arguments
key_size = 2048
key_ops = ["encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey"]
tags = {"purpose": "unit test", "test name ": "CreateRSAKeyTest"}
created_key = client.create_rsa_key(
key_name, hardware_protected=hsm, size=key_size, key_operations=key_ops, tags=tags
)
self.assertTrue(created_key.properties.tags, "Missing the optional key attributes.")
self.assertEqual(tags, created_key.properties.tags)
kty = "RSA-HSM" if hsm else "RSA"
self._validate_rsa_key_bundle(created_key, client.vault_url, key_name, kty, key_ops)
return created_key
def _create_ec_key(self, client, key_name, hsm=False):
# create ec key with optional arguments
enabled = True
tags = {"purpose": "unit test", "test name": "CreateECKeyTest"}
created_key = client.create_ec_key(key_name, hardware_protected=hsm, enabled=enabled, tags=tags)
key_type = "EC-HSM" if hsm else "EC"
self.assertTrue(created_key.properties.enabled, "Missing the optional key attributes.")
self.assertEqual(enabled, created_key.properties.enabled)
self.assertEqual(tags, created_key.properties.tags)
self._validate_ec_key_bundle(created_key, client.vault_url, key_name, key_type)
return created_key
def _validate_ec_key_bundle(self, key_attributes, vault, key_name, kty):
key_curve = "P-256"
prefix = "/".join(s.strip("/") for s in [vault, "keys", key_name])
key = key_attributes.key
kid = key_attributes.id
self.assertEqual(key_curve, key.crv)
self.assertTrue(kid.index(prefix) == 0, "Key Id should start with '{}', but value is '{}'".format(prefix, kid))
self.assertEqual(key.kty, kty, "kty should by '{}', but is '{}'".format(key, key.kty))
self.assertTrue(
key_attributes.properties.created_on and key_attributes.properties.updated_on,
"Missing required date attributes.",
)
def _validate_rsa_key_bundle(self, key_attributes, vault, key_name, kty, key_ops):
prefix = "/".join(s.strip("/") for s in [vault, "keys", key_name])
key = key_attributes.key
kid = key_attributes.id
self.assertTrue(kid.index(prefix) == 0, "Key Id should start with '{}', but value is '{}'".format(prefix, kid))
self.assertEqual(key.kty, kty, "kty should by '{}', but is '{}'".format(key, key.kty))
self.assertTrue(key.n and key.e, "Bad RSA public material.")
self.assertEqual(key_ops, key.key_ops, "keyOps should be '{}', but is '{}'".format(key_ops, key.key_ops))
self.assertTrue(
key_attributes.properties.created_on and key_attributes.properties.updated_on,
"Missing required date attributes.",
)
def _update_key_properties(self, client, key):
expires = date_parse.parse("2050-01-02T08:00:00.000Z")
tags = {"foo": "updated tag"}
key_ops = ["decrypt", "encrypt"]
key_bundle = client.update_key_properties(key.name, key_operations=key_ops, expires_on=expires, tags=tags)
self.assertEqual(tags, key_bundle.properties.tags)
self.assertEqual(key.id, key_bundle.id)
self.assertNotEqual(key.properties.updated_on, key_bundle.properties.updated_on)
self.assertEqual(key_ops, key_bundle.key_operations)
return key_bundle
def _import_test_key(self, client, name):
def _to_bytes(hex):
if len(hex) % 2:
hex = "0{}".format(hex)
return codecs.decode(hex, "hex_codec")
key = JsonWebKey(
kty="RSA",
key_ops=["encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey"],
n=_to_bytes(
"00a0914d00234ac683b21b4c15d5bed887bdc959c2e57af54ae734e8f00720d775d275e455207e3784ceeb60a50a4655dd72a7a94d271e8ee8f7959a669ca6e775bf0e23badae991b4529d978528b4bd90521d32dd2656796ba82b6bbfc7668c8f5eeb5053747fd199319d29a8440d08f4412d527ff9311eda71825920b47b1c46b11ab3e91d7316407e89c7f340f7b85a34042ce51743b27d4718403d34c7b438af6181be05e4d11eb985d38253d7fe9bf53fc2f1b002d22d2d793fa79a504b6ab42d0492804d7071d727a06cf3a8893aa542b1503f832b296371b6707d4dc6e372f8fe67d8ded1c908fde45ce03bc086a71487fa75e43aa0e0679aa0d20efe35"
),
e=_to_bytes("10001"),
d=_to_bytes(
"627c7d24668148fe2252c7fa649ea8a5a9ed44d75c766cda42b29b660e99404f0e862d4561a6c95af6a83d213e0a2244b03cd28576473215073785fb067f015da19084ade9f475e08b040a9a2c7ba00253bb8125508c9df140b75161d266be347a5e0f6900fe1d8bbf78ccc25eeb37e0c9d188d6e1fc15169ba4fe12276193d77790d2326928bd60d0d01d6ead8d6ac4861abadceec95358fd6689c50a1671a4a936d2376440a41445501da4e74bfb98f823bd19c45b94eb01d98fc0d2f284507f018ebd929b8180dbe6381fdd434bffb7800aaabdd973d55f9eaf9bb88a6ea7b28c2a80231e72de1ad244826d665582c2362761019de2e9f10cb8bcc2625649"
),
p=_to_bytes(
"00d1deac8d68ddd2c1fd52d5999655b2cf1565260de5269e43fd2a85f39280e1708ffff0682166cb6106ee5ea5e9ffd9f98d0becc9ff2cda2febc97259215ad84b9051e563e14a051dce438bc6541a24ac4f014cf9732d36ebfc1e61a00d82cbe412090f7793cfbd4b7605be133dfc3991f7e1bed5786f337de5036fc1e2df4cf3"
),
q=_to_bytes(
"00c3dc66b641a9b73cd833bc439cd34fc6574465ab5b7e8a92d32595a224d56d911e74624225b48c15a670282a51c40d1dad4bc2e9a3c8dab0c76f10052dfb053bc6ed42c65288a8e8bace7a8881184323f94d7db17ea6dfba651218f931a93b8f738f3d8fd3f6ba218d35b96861a0f584b0ab88ddcf446b9815f4d287d83a3237"
),
dp=_to_bytes(
"00c9a159be7265cbbabc9afcc4967eb74fe58a4c4945431902d1142da599b760e03838f8cbd26b64324fea6bdc9338503f459793636e59b5361d1e6951e08ddb089e1b507be952a81fbeaf7e76890ea4f536e25505c3f648b1e88377dfc19b4c304e738dfca07211b792286a392a704d0f444c0a802539110b7f1f121c00cff0a9"
),
dq=_to_bytes(
"00a0bd4c0a3d9f64436a082374b5caf2488bac1568696153a6a5e4cd85d186db31e2f58f024c617d29f37b4e6b54c97a1e25efec59c4d1fd3061ac33509ce8cae5c11f4cd2e83f41a8264f785e78dc0996076ee23dfdfc43d67c463afaa0180c4a718357f9a6f270d542479a0f213870e661fb950abca4a14ca290570ba7983347"
),
qi=_to_bytes(
"009fe7ae42e92bc04fcd5780464bd21d0c8ac0c599f9af020fde6ab0a7e7d1d39902f5d8fb6c614184c4c1b103fb46e94cd10a6c8a40f9991a1f28269f326435b6c50276fda6493353c650a833f724d80c7d522ba16c79f0eb61f672736b68fb8be3243d10943c4ab7028d09e76cfb5892222e38bc4d35585bf35a88cd68c73b07"
),
)
imported_key = client.import_key(name, key)
self._validate_rsa_key_bundle(imported_key, client.vault_url, name, key.kty, key.key_ops)
return imported_key
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_key_crud_operations(self, client, **kwargs):
self.assertIsNotNone(client)
# create ec key
self._create_ec_key(client, key_name="crud-ec-key", hsm=True)
# create ec with curve
created_ec_key_curve = client.create_ec_key(name="crud-P-256-ec-key", curve="P-256")
self.assertEqual("P-256", created_ec_key_curve.key.crv)
# import key
self._import_test_key(client, "import-test-key")
# create rsa key
created_rsa_key = self._create_rsa_key(client, key_name="crud-rsa-key")
# get the created key with version
key = client.get_key(created_rsa_key.name, created_rsa_key.properties.version)
self.assertEqual(key.properties.version, created_rsa_key.properties.version)
self._assert_key_attributes_equal(created_rsa_key.properties, key.properties)
# get key without version
self._assert_key_attributes_equal(created_rsa_key.properties, client.get_key(created_rsa_key.name).properties)
# update key with version
if self.is_live:
# wait to ensure the key's update time won't equal its creation time
time.sleep(1)
self._update_key_properties(client, created_rsa_key)
# delete the new key
deleted_key_poller = client.begin_delete_key(created_rsa_key.name)
deleted_key = deleted_key_poller.result()
self.assertIsNotNone(deleted_key)
self.assertEqual(created_rsa_key.key_type, deleted_key.key_type)
self.assertEqual(deleted_key.id, created_rsa_key.id)
self.assertTrue(
deleted_key.recovery_id and deleted_key.deleted_date and deleted_key.scheduled_purge_date,
"Missing required deleted key attributes.",
)
deleted_key_poller.wait()
# get the deleted key when soft deleted enabled
deleted_key = client.get_deleted_key(created_rsa_key.name)
self.assertIsNotNone(deleted_key)
self.assertEqual(created_rsa_key.id, deleted_key.id)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_backup_restore(self, client, **kwargs):
self.assertIsNotNone(client)
key_name = self.get_resource_name("keybak")
key_type = "RSA"
# create key
created_bundle = client.create_key(key_name, key_type)
self.assertEqual(key_type, created_bundle.key_type)
# backup key
key_backup = client.backup_key(created_bundle.name)
self.assertIsNotNone(key_backup, "key_backup")
# delete key
client.begin_delete_key(created_bundle.name).wait()
# purge key
client.purge_deleted_key(created_bundle.name)
# restore key
restore_function = functools.partial(client.restore_key_backup, key_backup)
restored_key = self._poll_until_no_exception(restore_function, ResourceExistsError)
self._assert_key_attributes_equal(created_bundle.properties, restored_key.properties)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_key_list(self, client, **kwargs):
self.assertIsNotNone(client)
max_keys = self.list_test_size
expected = {}
# create many keys
for x in range(max_keys):
key_name = "key{}".format(x)
key = client.create_key(key_name, "RSA")
expected[key.name] = key
# list keys
result = client.list_properties_of_keys(max_page_size=max_keys - 1)
for key in result:
if key.name in expected.keys():
self._assert_key_attributes_equal(expected[key.name].properties, key)
del expected[key.name]
self.assertEqual(len(expected), 0)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_list_versions(self, client, **kwargs):
self.assertIsNotNone(client)
key_name = self.get_resource_name("testKey")
max_keys = self.list_test_size
expected = {}
# create many key versions
for _ in range(max_keys):
key = client.create_key(key_name, "RSA")
expected[key.id] = key
result = client.list_properties_of_key_versions(key_name, max_page_size=max_keys - 1)
# validate list key versions with attributes
for key in result:
if key.id in expected.keys():
expected_key = expected[key.id]
del expected[key.id]
self._assert_key_attributes_equal(expected_key.properties, key)
self.assertEqual(0, len(expected))
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_list_deleted_keys(self, client, **kwargs):
self.assertIsNotNone(client)
expected = {}
# create keys
for i in range(self.list_test_size):
key_name = "key{}".format(i)
key_value = "value{}".format(i)
expected[key_name] = client.create_key(key_name, "RSA")
# delete them
for key_name in expected.keys():
client.begin_delete_key(key_name).wait()
# validate list deleted keys with attributes
for deleted_key in client.list_deleted_keys():
self.assertIsNotNone(deleted_key.deleted_date)
self.assertIsNotNone(deleted_key.scheduled_purge_date)
self.assertIsNotNone(deleted_key.recovery_id)
result = client.list_deleted_keys()
# validate all the deleted keys are returned by list_deleted_keys
for key in result:
if key.name in expected.keys():
self._assert_key_attributes_equal(expected[key.name].properties, key.properties)
del expected[key.name]
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_recover(self, client, **kwargs):
self.assertIsNotNone(client)
# create keys
keys = {}
for i in range(self.list_test_size):
key_name = "key{}".format(i)
keys[key_name] = client.create_key(key_name, "RSA")
# delete them
for key_name in keys.keys():
client.begin_delete_key(key_name).wait()
# validate the deleted keys are returned by list_deleted_keys
deleted = [s.name for s in client.list_deleted_keys()]
self.assertTrue(all(s in deleted for s in keys.keys()))
# recover the keys
for key_name in keys.keys():
recovered_key = client.begin_recover_deleted_key(key_name).result()
expected_key = keys[key_name]
self._assert_key_attributes_equal(expected_key.properties, recovered_key.properties)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_purge(self, client, **kwargs):
self.assertIsNotNone(client)
# create keys
key_names = ["key{}".format(i) for i in range(self.list_test_size)]
for name in key_names:
client.create_key(name, "RSA")
# delete them
for key_name in key_names:
client.begin_delete_key(key_name).wait()
# validate all our deleted keys are returned by list_deleted_keys
deleted = [k.name for k in client.list_deleted_keys()]
self.assertTrue(all(n in deleted for n in key_names))
# purge them
for key_name in key_names:
client.purge_deleted_key(key_name)
for key_name in key_names:
self._poll_until_exception(
functools.partial(client.get_deleted_key, key_name), expected_exception=ResourceNotFoundError
)
# validate none are returned by list_deleted_keys
deleted = [s.name for s in client.list_deleted_keys()]
self.assertTrue(not any(s in deleted for s in key_names))
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer(client_kwargs={"logging_enable": True})
def test_logging_enabled(self, client, **kwargs):
mock_handler = MockHandler()
logger = logging.getLogger("azure")
logger.addHandler(mock_handler)
logger.setLevel(logging.DEBUG)
client.create_rsa_key("rsa-key-name", size=2048)
for message in mock_handler.messages:
if message.levelname == "DEBUG" and message.funcName == "on_request":
try:
body = json.loads(message.message)
if body["kty"] == "RSA":
return
except (ValueError, KeyError):
# this means the message is not JSON or has no kty property
pass
assert False, "Expected request body wasn't logged"
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
def test_logging_disabled(self, client, **kwargs):
mock_handler = MockHandler()
logger = logging.getLogger("azure")
logger.addHandler(mock_handler)
logger.setLevel(logging.DEBUG)
client.create_rsa_key("rsa-key-name", size=2048)
for message in mock_handler.messages:
if message.levelname == "DEBUG" and message.funcName == "on_request":
try:
body = json.loads(message.message)
assert body["kty"] != "RSA", "Client request body was logged"
except (ValueError, KeyError):
# this means the message is not JSON or has no kty property
pass
def test_service_headers_allowed_in_logs():
service_headers = {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}
client = KeyClient("...", object())
assert service_headers.issubset(client._client._config.http_logging_policy.allowed_header_names)
def test_custom_hook_policy():
class CustomHookPolicy(object):
pass
client = KeyClient("...", object(), custom_hook_policy=CustomHookPolicy())
assert isinstance(client._client._config.custom_hook_policy, CustomHookPolicy)
|