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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import asyncio
import functools
import logging
import json
from azure.core.exceptions import ResourceExistsError, ResourceNotFoundError
from azure.keyvault.secrets.aio import SecretClient
from devtools_testutils import ResourceGroupPreparer, KeyVaultPreparer
from _shared.preparer_async import KeyVaultClientPreparer as _KeyVaultClientPreparer
from _shared.test_case_async import KeyVaultTestCase
from dateutil import parser as date_parse
# pre-apply the client_cls positional argument so it needn't be explicitly passed below
KeyVaultClientPreparer = functools.partial(_KeyVaultClientPreparer, SecretClient)
# 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 KeyVaultSecretTest(KeyVaultTestCase):
def _assert_secret_attributes_equal(self, s1, s2):
self.assertEqual(s1.name, s2.name)
self.assertEqual(s1.vault_url, s2.vault_url)
self.assertEqual(s1.content_type, s2.content_type)
self.assertEqual(s1.enabled, s2.enabled)
self.assertEqual(s1.not_before, s2.not_before)
self.assertEqual(s1.expires_on, s2.expires_on)
self.assertEqual(s1.created_on, s2.created_on)
self.assertEqual(s1.updated_on, s2.updated_on)
self.assertEqual(s1.recovery_level, s2.recovery_level)
self.assertEqual(s1.key_id, s2.key_id)
def _validate_secret_bundle(self, secret_attributes, vault, secret_name, secret_value):
prefix = "/".join(s.strip("/") for s in [vault, "secrets", secret_name])
id = secret_attributes.id
self.assertTrue(id.index(prefix) == 0, "Id should start with '{}', but value is '{}'".format(prefix, id))
self.assertEqual(
secret_attributes.value,
secret_value,
"value should be '{}', but is '{}'".format(secret_value, secret_attributes.value),
)
self.assertTrue(
secret_attributes.properties.created_on and secret_attributes.properties.updated_on,
"Missing required date attributes.",
)
async def _validate_secret_list(self, secrets, expected):
async for secret in secrets:
# TODO: what if secrets contains unexpected entries?
if secret.name in expected.keys():
expected_secret = expected[secret.name]
self._assert_secret_attributes_equal(expected_secret.properties, secret)
del expected[secret.name]
self.assertEqual(len(expected), 0)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_secret_crud_operations(self, client, **kwargs):
secret_name = "crud-secret"
secret_value = self.get_resource_name("crud_secret_value")
# create secret
created = await client.set_secret(secret_name, secret_value)
self._validate_secret_bundle(created, client.vault_url, secret_name, secret_value)
# set secret with optional arguments
not_before = date_parse.parse("2015-02-02T08:00:00.000Z")
enabled = True
tags = {"foo": "created tag"}
created = await client.set_secret(secret_name, secret_value, enabled=enabled, not_before=not_before, tags=tags)
self._validate_secret_bundle(created, client.vault_url, secret_name, secret_value)
self.assertEqual(enabled, created.properties.enabled)
self.assertEqual(not_before, created.properties.not_before)
self.assertEqual(tags, created.properties.tags)
# get secret without version
retrieved_secret = await client.get_secret(created.name, "")
self.assertEqual(created.id, retrieved_secret.id)
self._assert_secret_attributes_equal(created.properties, retrieved_secret.properties)
# get secret with version
secret_with_version = await client.get_secret(created.name, created.properties.version)
self.assertEqual(created.id, retrieved_secret.id)
self._assert_secret_attributes_equal(created.properties, secret_with_version.properties)
async def _update_secret(secret):
content_type = "text/plain"
expires = date_parse.parse("2050-02-02T08:00:00.000Z")
tags = {"foo": "updated tag"}
enabled = not secret.properties.enabled
updated_secret = await client.update_secret_properties(
secret.name,
version=secret.properties.version,
content_type=content_type,
expires_on=expires,
tags=tags,
enabled=enabled,
)
self.assertEqual(tags, updated_secret.tags)
self.assertEqual(secret.id, updated_secret.id)
self.assertEqual(content_type, updated_secret.content_type)
self.assertEqual(expires, updated_secret.expires_on)
self.assertNotEqual(secret.properties.enabled, updated_secret.enabled)
self.assertNotEqual(secret.properties.updated_on, updated_secret.updated_on)
return updated_secret
# update secret with version
if self.is_live:
# wait a second to ensure the secret's update time won't equal its creation time
await asyncio.sleep(1)
updated = await _update_secret(created)
# delete secret
deleted = await client.delete_secret(updated.name)
self.assertIsNotNone(deleted)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_secret_list(self, client, **kwargs):
max_secrets = self.list_test_size
expected = {}
# create many secrets
for x in range(0, max_secrets):
secret_name = "sec{}".format(x)
secret_value = self.get_resource_name("secVal{}".format(x))
secret = None
while not secret:
secret = await client.set_secret(secret_name, secret_value)
expected[secret_name] = secret
# list secrets
result = client.list_properties_of_secrets(max_page_size=max_secrets - 1)
await self._validate_secret_list(result, expected)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_list_deleted_secrets(self, client, **kwargs):
expected = {}
# create secrets
for i in range(self.list_test_size):
secret_name = "secret{}".format(i)
secret_value = "value{}".format(i)
expected[secret_name] = await client.set_secret(secret_name, secret_value)
# delete them
for secret_name in expected.keys():
await client.delete_secret(secret_name)
# validate list deleted secrets with attributes
async for deleted_secret in client.list_deleted_secrets():
self.assertIsNotNone(deleted_secret.deleted_date)
self.assertIsNotNone(deleted_secret.scheduled_purge_date)
self.assertIsNotNone(deleted_secret.recovery_id)
expected_secret = expected[deleted_secret.name]
self._assert_secret_attributes_equal(expected_secret.properties, deleted_secret.properties)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_list_versions(self, client, **kwargs):
secret_name = self.get_resource_name("sec")
secret_value = self.get_resource_name("secVal")
max_secrets = self.list_test_size
expected = {}
# create many secret versions
for _ in range(0, max_secrets):
secret = None
while not secret:
secret = await client.set_secret(secret_name, secret_value)
expected[secret.id] = secret
# list secret versions
result = client.list_properties_of_secret_versions(secret_name, max_page_size=max_secrets - 1)
# validate list secret versions with attributes
async for secret in result:
if secret.id in expected.keys():
expected_secret = expected[secret.id]
del expected[secret.id]
self._assert_secret_attributes_equal(expected_secret.properties, secret)
self.assertEqual(len(expected), 0)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_backup_restore(self, client, **kwargs):
secret_name = self.get_resource_name("secbak")
secret_value = self.get_resource_name("secVal")
# create secret
created_bundle = await client.set_secret(secret_name, secret_value)
# backup secret
secret_backup = await client.backup_secret(created_bundle.name)
self.assertIsNotNone(secret_backup, "secret_backup")
# delete secret
await client.delete_secret(created_bundle.name)
# purge secret
await client.purge_deleted_secret(created_bundle.name)
# restore secret
restore_function = functools.partial(client.restore_secret_backup, secret_backup)
restored_secret = await self._poll_until_no_exception(restore_function, expected_exception=ResourceExistsError)
self._assert_secret_attributes_equal(created_bundle.properties, restored_secret)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_recover(self, client, **kwargs):
secrets = {}
# create secrets to recover
for i in range(self.list_test_size):
secret_name = "secret{}".format(i)
secret_value = "value{}".format(i)
secrets[secret_name] = await client.set_secret(secret_name, secret_value)
# delete all secrets
for secret_name in secrets.keys():
await client.delete_secret(secret_name)
# validate all our deleted secrets are returned by list_deleted_secrets
async for deleted_secret in client.list_deleted_secrets():
assert deleted_secret.name in secrets
# recover select secrets
for secret_name in secrets.keys():
await client.recover_deleted_secret(secret_name)
# validate the recovered secrets exist
for secret in secrets.keys():
get_function = functools.partial(client.get_secret, secret)
await self._poll_until_no_exception(get_function, expected_exception=ResourceNotFoundError)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer()
async def test_purge(self, client, **kwargs):
secrets = {}
# create secrets to purge
for i in range(self.list_test_size):
secret_name = "secret{}".format(i)
secret_value = "value{}".format(i)
secrets[secret_name] = await client.set_secret(secret_name, secret_value)
# delete all secrets
for secret_name in secrets.keys():
await client.delete_secret(secret_name)
# validate all our deleted secrets are returned by list_deleted_secrets
async for deleted_secret in client.list_deleted_secrets():
assert deleted_secret.name in secrets
# purge secrets
for secret_name in secrets.keys():
await client.purge_deleted_secret(secret_name)
@ResourceGroupPreparer(random_name_enabled=True)
@KeyVaultPreparer()
@KeyVaultClientPreparer(client_kwargs={"logging_enable": True})
async def test_logging_enabled(self, client, **kwargs):
mock_handler = MockHandler()
logger = logging.getLogger("azure")
logger.addHandler(mock_handler)
logger.setLevel(logging.DEBUG)
await client.set_secret("secret-name", "secret-value")
for message in mock_handler.messages:
if message.levelname == "DEBUG" and message.funcName == "on_request":
try:
body = json.loads(message.message)
if body["value"] == "secret-value":
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()
async def test_logging_disabled(self, client, **kwargs):
mock_handler = MockHandler()
logger = logging.getLogger("azure")
logger.addHandler(mock_handler)
logger.setLevel(logging.DEBUG)
await client.set_secret("secret-name", "secret-value")
for message in mock_handler.messages:
if message.levelname == "DEBUG" and message.funcName == "on_request":
try:
body = json.loads(message.message)
assert body["value"] != "secret-value", "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 = SecretClient("...", object())
assert service_headers.issubset(client._client._config.http_logging_policy.allowed_header_names)
def test_custom_hook_policy():
class CustomHookPolicy(object):
pass
client = SecretClient("...", object(), custom_hook_policy=CustomHookPolicy())
assert isinstance(client._client._config.custom_hook_policy, CustomHookPolicy)
|