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
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import base64
import json
import time
import os
import unittest
from io import StringIO
import pytest
from azure.core.credentials import AccessToken
import test_config
from azure.cosmos import exceptions
from azure.cosmos.aio import CosmosClient, DatabaseProxy, ContainerProxy
from azure.core.exceptions import HttpResponseError
def _remove_padding(encoded_string):
while encoded_string.endswith("="):
encoded_string = encoded_string[0:len(encoded_string) - 1]
return encoded_string
def get_test_item(num):
test_item = {
'pk': 'pk',
'id': 'Item_' + str(num),
'test_object': True,
'lastName': 'Smith'
}
return test_item
class CosmosEmulatorCredential(object):
async def get_token(self, *scopes, **kwargs):
# type: (*str, **Any) -> AccessToken
"""Request an access token for the emulator. Based on Azure Core's Access Token Credential.
This method is called automatically by Azure SDK clients.
:param str scopes: desired scopes for the access token. This method requires at least one scope.
:rtype: :class:`azure.core.credentials.AccessToken`
:raises CredentialUnavailableError: the credential is unable to attempt authentication because it lacks
required data, state, or platform support
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
attribute gives a reason.
"""
aad_header_cosmos_emulator = "{\"typ\":\"JWT\",\"alg\":\"RS256\",\"x5t\":\"" \
"CosmosEmulatorPrimaryMaster\",\"kid\":\"CosmosEmulatorPrimaryMaster\"}"
aad_claim_cosmos_emulator_format = {"aud": "https://localhost.localhost",
"iss": "https://sts.fake-issuer.net/7b1999a1-dfd7-440e-8204-00170979b984",
"iat": int(time.time()), "nbf": int(time.time()),
"exp": int(time.time() + 7200), "aio": "", "appid": "localhost",
"appidacr": "1", "idp": "https://localhost:8081/",
"oid": "96313034-4739-43cb-93cd-74193adbe5b6", "rh": "", "sub": "localhost",
"tid": "EmulatorFederation", "uti": "", "ver": "1.0",
"scp": "user_impersonation",
"groups": ["7ce1d003-4cb3-4879-b7c5-74062a35c66e",
"e99ff30c-c229-4c67-ab29-30a6aebc3e58",
"5549bb62-c77b-4305-bda9-9ec66b85d9e4",
"c44fd685-5c58-452c-aaf7-13ce75184f65",
"be895215-eab5-43b7-9536-9ef8fe130330"]}
emulator_key = test_config.TestConfig.masterKey
first_encoded_bytes = base64.urlsafe_b64encode(aad_header_cosmos_emulator.encode("utf-8"))
first_encoded_padded = str(first_encoded_bytes, "utf-8")
first_encoded = _remove_padding(first_encoded_padded)
str_io_obj = StringIO()
json.dump(aad_claim_cosmos_emulator_format, str_io_obj)
aad_claim_cosmos_emulator_format_string = str(str_io_obj.getvalue()).replace(" ", "")
second = aad_claim_cosmos_emulator_format_string
second_encoded_bytes = base64.urlsafe_b64encode(second.encode("utf-8"))
second_encoded_padded = str(second_encoded_bytes, "utf-8")
second_encoded = _remove_padding(second_encoded_padded)
emulator_key_encoded_bytes = base64.urlsafe_b64encode(emulator_key.encode("utf-8"))
emulator_key_encoded_padded = str(emulator_key_encoded_bytes, "utf-8")
emulator_key_encoded = _remove_padding(emulator_key_encoded_padded)
return AccessToken(first_encoded + "." + second_encoded + "." + emulator_key_encoded, int(time.time() + 7200))
@pytest.mark.cosmosEmulator
class TestAADAsync(unittest.IsolatedAsyncioTestCase):
client: CosmosClient = None
database: DatabaseProxy = None
container: ContainerProxy = None
configs = test_config.TestConfig
host = configs.host
masterKey = configs.masterKey
credential = CosmosEmulatorCredential() if configs.is_emulator else configs.credential_async
@classmethod
def setUpClass(cls):
if (cls.credential == '[YOUR_KEY_HERE]' or
cls.host == '[YOUR_ENDPOINT_HERE]'):
raise Exception(
"You must specify your Azure Cosmos account values for "
"'masterKey' and 'host' at the top of this class to run the "
"tests.")
async def asyncSetUp(self):
self.client = CosmosClient(self.host, self.credential)
self.database = self.client.get_database_client(self.configs.TEST_DATABASE_ID)
self.container = self.database.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
async def asyncTearDown(self):
await self.client.close()
async def test_aad_credentials_async(self):
# Do any R/W data operations with your authorized AAD client
print("Container info: " + str(await self.container.read()))
await self.container.create_item(get_test_item(0))
print("Point read result: " + str(await self.container.read_item(item='Item_0', partition_key='pk')))
query_results = [item async for item in self.container.query_items(query='select * from c', partition_key='pk')]
assert len(query_results) == 1
print("Query result: " + str(query_results[0]))
await self.container.delete_item(item='Item_0', partition_key='pk')
# Attempting to do management operations will return a 403 Forbidden exception
try:
await self.client.delete_database(self.configs.TEST_DATABASE_ID)
except exceptions.CosmosHttpResponseError as e:
assert e.status_code == 403
print("403 error assertion success")
async def _run_with_scope_capture_async(self, credential_cls, action):
scopes_captured = []
orig_get_token = credential_cls.get_token
async def capturing_get_token(self, *scopes, **kwargs):
scopes_captured.extend(scopes)
return await orig_get_token(self, *scopes, **kwargs)
credential_cls.get_token = capturing_get_token
try:
result = await action(scopes_captured)
return scopes_captured, result
finally:
credential_cls.get_token = orig_get_token
async def test_override_scope_no_fallback_async(self):
"""When override scope is provided, only that scope is used and no fallback occurs."""
override_scope = "https://my.custom.scope/.default"
os.environ["AZURE_COSMOS_AAD_SCOPE_OVERRIDE"] = override_scope
async def action(scopes_captured):
credential = CosmosEmulatorCredential()
client = CosmosClient(self.host, credential)
try:
db = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = db.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
await container.create_item(get_test_item(20))
return container
finally:
await client.close()
scopes, container = await self._run_with_scope_capture_async(CosmosEmulatorCredential, action)
try:
assert all(scope == override_scope for scope in scopes), f"Expected only override scope, got: {scopes}"
finally:
del os.environ["AZURE_COSMOS_AAD_SCOPE_OVERRIDE"]
try:
await container.delete_item(item='Item_20', partition_key='pk')
except Exception:
pass
async def test_override_scope_no_fallback_on_error_async(self):
"""When override scope is provided and auth fails, no fallback occurs."""
override_scope = "https://my.custom.scope/.default"
os.environ["AZURE_COSMOS_AAD_SCOPE_OVERRIDE"] = override_scope
class FailingCredential(CosmosEmulatorCredential):
async def get_token(self, *scopes, **kwargs):
raise Exception("AADSTS500011: Simulated error for override scope")
async def action(scopes_captured):
credential = FailingCredential()
client = CosmosClient(self.host, credential)
try:
db = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = db.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
try:
await container.create_item(get_test_item(21))
except Exception:
pass
return container
finally:
await client.close()
scopes, container = await self._run_with_scope_capture_async(FailingCredential, action)
try:
assert all(scope == override_scope for scope in scopes), f"Expected only override scope, got: {scopes}"
finally:
del os.environ["AZURE_COSMOS_AAD_SCOPE_OVERRIDE"]
try:
await container.delete_item(item='Item_21', partition_key='pk')
except Exception:
pass
async def test_account_scope_only_async(self):
"""When account scope is provided, only that scope is used."""
account_scope = "https://localhost/.default"
os.environ["AZURE_COSMOS_AAD_SCOPE_OVERRIDE"] = ""
async def action(scopes_captured):
credential = CosmosEmulatorCredential()
client = CosmosClient(self.host, credential)
try:
db = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = db.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
await container.create_item(get_test_item(22))
return container
finally:
await client.close()
scopes, container = await self._run_with_scope_capture_async(CosmosEmulatorCredential, action)
try:
assert all(scope == account_scope for scope in scopes), f"Expected only account scope, got: {scopes}"
finally:
try:
await container.delete_item(item='Item_22', partition_key='pk')
except Exception:
pass
async def test_account_scope_fallback_on_error_async(self):
"""When account scope is provided and auth fails, fallback to default scope occurs."""
account_scope = "https://localhost/.default"
fallback_scope = "https://cosmos.azure.com/.default"
os.environ["AZURE_COSMOS_AAD_SCOPE_OVERRIDE"] = ""
class FallbackCredential(CosmosEmulatorCredential):
def __init__(self):
self.call_count = 0
async def get_token(self, *scopes, **kwargs):
self.call_count += 1
if self.call_count == 1:
raise HttpResponseError(message="AADSTS500011: Simulated error for fallback")
return await super().get_token(*scopes, **kwargs)
async def action(scopes_captured):
credential = FallbackCredential()
client = CosmosClient(self.host, credential)
try:
db = client.get_database_client(self.configs.TEST_DATABASE_ID)
container = db.get_container_client(self.configs.TEST_SINGLE_PARTITION_CONTAINER_ID)
await container.create_item(get_test_item(23))
return container
finally:
await client.close()
scopes, container = await self._run_with_scope_capture_async(FallbackCredential, action)
try:
assert account_scope in scopes and fallback_scope in scopes, f"Expected fallback to default scope, got: {scopes}"
finally:
try:
await container.delete_item(item='Item_23', partition_key='pk')
except Exception:
pass
if __name__ == "__main__":
unittest.main()
|
