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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
from datetime import datetime
from itertools import product
import json
import re
from azure.identity import AzureCliCredential, CredentialUnavailableError
from azure.identity._constants import EnvironmentVariables
from azure.identity._credentials.azure_cli import CLI_NOT_FOUND, NOT_LOGGED_IN
from azure.core.exceptions import ClientAuthenticationError
import subprocess
import pytest
from helpers import mock, INVALID_CHARACTERS, INVALID_SUBSCRIPTION_CHARACTERS, GET_TOKEN_METHODS
CHECK_OUTPUT = AzureCliCredential.__module__ + ".subprocess.check_output"
TEST_ERROR_OUTPUTS = (
'{"accessToken": "secret value',
'{"accessToken": "secret value"',
'{"accessToken": "secret value and some other nonsense"',
'{"accessToken": "secret value", some invalid json, "accessToken": "secret value"}',
'{"accessToken": "secret value"}',
'{"accessToken": "secret value", "subscription": "some-guid", "tenant": "some-guid", "tokenType": "Bearer"}',
"no secrets or json here",
"{}",
)
def raise_called_process_error(return_code, output="", cmd="...", stderr=""):
error = subprocess.CalledProcessError(return_code, cmd=cmd, output=output, stderr=stderr)
return mock.Mock(side_effect=error)
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_no_scopes(get_token_method):
"""The credential should raise ValueError when get_token is called with no scopes"""
with pytest.raises(ValueError):
getattr(AzureCliCredential(), get_token_method)()
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_multiple_scopes(get_token_method):
"""The credential should raise ValueError when get_token is called with more than one scope"""
with pytest.raises(ValueError):
getattr(AzureCliCredential(), get_token_method)("one scope", "and another")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_invalid_tenant_id(get_token_method):
"""Invalid tenant IDs should raise ValueErrors."""
for c in INVALID_CHARACTERS:
with pytest.raises(ValueError):
AzureCliCredential(tenant_id="tenant" + c)
with pytest.raises(ValueError):
kwargs = {"tenant_id": "tenant" + c}
if get_token_method == "get_token_info":
kwargs = {"options": kwargs}
getattr(AzureCliCredential(), get_token_method)("scope", **kwargs)
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_invalid_scopes(get_token_method):
"""Scopes with invalid characters should raise ValueErrors."""
for c in INVALID_CHARACTERS:
with pytest.raises(ValueError):
getattr(AzureCliCredential(), get_token_method)("scope" + c)
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_subscription(get_token_method):
"""The credential should accept a subscription ID"""
subscription = "foo subscription"
credential = AzureCliCredential(subscription=subscription)
assert credential.subscription == subscription
def fake_check_output(command_line, **_):
assert "--subscription" in command_line
subscription_id_index = command_line.index("--subscription")
assert command_line[subscription_id_index + 1]
return json.dumps(
{
"expiresOn": datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
"accessToken": "access-token",
"subscription": subscription,
"tenant": "tenant",
"tokenType": "Bearer",
}
)
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, fake_check_output):
token = getattr(credential, get_token_method)("scope")
assert token.token == "access-token"
def test_invalid_subscriptons():
"""Subscriptions with invalid characters should raise ValueErrors."""
for c in INVALID_SUBSCRIPTION_CHARACTERS:
with pytest.raises(ValueError):
AzureCliCredential(subscription="subscription" + c)
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_get_token(get_token_method):
"""The credential should parse the CLI's output to an AccessToken"""
access_token = "access token"
expected_expires_on = 1602015811
successful_output = json.dumps(
{
"expiresOn": datetime.fromtimestamp(expected_expires_on).strftime("%Y-%m-%d %H:%M:%S.%f"),
"accessToken": access_token,
"subscription": "some-guid",
"tenant": "some-guid",
"tokenType": "Bearer",
}
)
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, mock.Mock(return_value=successful_output)):
token = getattr(AzureCliCredential(), get_token_method)("scope")
assert token.token == access_token
assert type(token.expires_on) == int
assert token.expires_on == expected_expires_on
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_expires_on_used(get_token_method):
"""Test that 'expires_on' is preferred over 'expiresOn'."""
expires_on = 1602015811
successful_output = json.dumps(
{
"expiresOn": datetime.fromtimestamp(1555555555).strftime("%Y-%m-%d %H:%M:%S.%f"),
"expires_on": expires_on,
"accessToken": "access token",
"subscription": "some-guid",
"tenant": "some-guid",
"tokenType": "Bearer",
}
)
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, mock.Mock(return_value=successful_output)):
token = getattr(AzureCliCredential(), get_token_method)("scope")
assert token.expires_on == expires_on
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_expires_on_string(get_token_method):
"""Test that 'expires_on' still works if it's a string."""
expires_on = 1602015811
successful_output = json.dumps(
{
"expires_on": f"{expires_on}",
"accessToken": "access token",
"subscription": "some-guid",
"tenant": "some-guid",
"tokenType": "Bearer",
}
)
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, mock.Mock(return_value=successful_output)):
token = getattr(AzureCliCredential(), get_token_method)("scope")
assert type(token.expires_on) == int
assert token.expires_on == expires_on
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_cli_not_installed(get_token_method):
"""The credential should raise CredentialUnavailableError when the CLI isn't installed"""
with mock.patch("shutil.which", return_value=None):
with pytest.raises(CredentialUnavailableError, match=CLI_NOT_FOUND):
getattr(AzureCliCredential(), get_token_method)("scope")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_cannot_execute_shell(get_token_method):
"""The credential should raise CredentialUnavailableError when the subprocess doesn't start"""
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, mock.Mock(side_effect=OSError())):
with pytest.raises(CredentialUnavailableError):
getattr(AzureCliCredential(), get_token_method)("scope")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_not_logged_in(get_token_method):
"""When the CLI isn't logged in, the credential should raise CredentialUnavailableError"""
stderr = "ERROR: Please run 'az login' to setup account."
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, raise_called_process_error(1, stderr=stderr)):
with pytest.raises(CredentialUnavailableError, match=NOT_LOGGED_IN):
getattr(AzureCliCredential(), get_token_method)("scope")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_aadsts_error(get_token_method):
"""When the CLI isn't logged in, the credential should raise CredentialUnavailableError"""
stderr = "ERROR: AADSTS70043: The refresh token has expired, Please run 'az login' to setup account."
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, raise_called_process_error(1, stderr=stderr)):
with pytest.raises(ClientAuthenticationError, match=stderr):
getattr(AzureCliCredential(), get_token_method)("scope")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_unexpected_error(get_token_method):
"""When the CLI returns an unexpected error, the credential should raise an error containing the CLI's output"""
stderr = "something went wrong"
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, raise_called_process_error(42, stderr=stderr)):
with pytest.raises(ClientAuthenticationError, match=stderr):
getattr(AzureCliCredential(), get_token_method)("scope")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_unexpected_error_no_stderr(get_token_method):
"""When the CLI returns an unexpected error with no stderr captured, the credential should raise an error with a str output"""
stderr = None
default_message = "Failed to invoke Azure CLI"
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, raise_called_process_error(42, stderr=stderr)):
with pytest.raises(ClientAuthenticationError, match=stderr):
getattr(AzureCliCredential(), get_token_method)("scope")
@pytest.mark.parametrize("output,get_token_method", product(TEST_ERROR_OUTPUTS, GET_TOKEN_METHODS))
def test_parsing_error_does_not_expose_token(output, get_token_method):
"""Errors during CLI output parsing shouldn't expose access tokens in that output"""
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, mock.Mock(return_value=output)):
with pytest.raises(ClientAuthenticationError) as ex:
getattr(AzureCliCredential(), get_token_method)("scope")
assert "secret value" not in str(ex.value)
assert "secret value" not in repr(ex.value)
@pytest.mark.parametrize("output,get_token_method", product(TEST_ERROR_OUTPUTS, GET_TOKEN_METHODS))
def test_subprocess_error_does_not_expose_token(output, get_token_method):
"""Errors from the subprocess shouldn't expose access tokens in CLI output"""
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, raise_called_process_error(1, output=output)):
with pytest.raises(ClientAuthenticationError) as ex:
getattr(AzureCliCredential(), get_token_method)("scope")
assert "secret value" not in str(ex.value)
assert "secret value" not in repr(ex.value)
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_timeout(get_token_method):
"""The credential should raise CredentialUnavailableError when the subprocess times out"""
from subprocess import TimeoutExpired
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, mock.Mock(side_effect=TimeoutExpired("", 42))) as check_output_mock:
with pytest.raises(CredentialUnavailableError):
getattr(AzureCliCredential(process_timeout=42), get_token_method)("scope")
# Ensure custom timeout is passed to subprocess
_, kwargs = check_output_mock.call_args
assert "timeout" in kwargs
assert kwargs["timeout"] == 42
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_multitenant_authentication_class(get_token_method):
default_tenant = "first-tenant"
first_token = "***"
second_tenant = "second-tenant"
second_token = first_token * 2
def fake_check_output(command_line, **_):
tenant_index = command_line.index("--tenant") if "--tenant" in command_line else None
tenant = command_line[tenant_index + 1] if tenant_index is not None else default_tenant
assert tenant in (default_tenant, second_tenant), 'unexpected tenant "{}"'.format(tenant)
return json.dumps(
{
"expiresOn": datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
"accessToken": first_token if tenant == default_tenant else second_token,
"subscription": "some-guid",
"tenant": tenant,
"tokenType": "Bearer",
}
)
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, fake_check_output):
token = getattr(AzureCliCredential(), get_token_method)("scope")
assert token.token == first_token
token = getattr(AzureCliCredential(tenant_id=default_tenant), get_token_method)("scope")
assert token.token == first_token
token = getattr(AzureCliCredential(tenant_id=second_tenant), get_token_method)("scope")
assert token.token == second_token
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_multitenant_authentication(get_token_method):
default_tenant = "first-tenant"
first_token = "***"
second_tenant = "second-tenant"
second_token = first_token * 2
def fake_check_output(command_line, **_):
tenant_index = command_line.index("--tenant") if "--tenant" in command_line else None
tenant = command_line[tenant_index + 1] if tenant_index is not None else default_tenant
assert tenant in (default_tenant, second_tenant), 'unexpected tenant "{}"'.format(tenant)
return json.dumps(
{
"expiresOn": datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
"accessToken": first_token if tenant == default_tenant else second_token,
"subscription": "some-guid",
"tenant": tenant,
"tokenType": "Bearer",
}
)
credential = AzureCliCredential()
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, fake_check_output):
token = getattr(credential, get_token_method)("scope")
assert token.token == first_token
kwargs = {"tenant_id": default_tenant}
if get_token_method == "get_token_info":
kwargs = {"options": kwargs}
token = getattr(credential, get_token_method)("scope", **kwargs)
assert token.token == first_token
kwargs = {"tenant_id": second_tenant}
if get_token_method == "get_token_info":
kwargs = {"options": kwargs}
token = getattr(credential, get_token_method)("scope", **kwargs)
assert token.token == second_token
# should still default to the first tenant
token = getattr(credential, get_token_method)("scope")
assert token.token == first_token
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_multitenant_authentication_not_allowed(get_token_method):
expected_tenant = "expected-tenant"
expected_token = "***"
def fake_check_output(command_line, **_):
tenant_index = command_line.index("--tenant") if "--tenant" in command_line else None
tenant = command_line[tenant_index + 1] if tenant_index is not None else None
assert tenant is None or tenant == expected_tenant
return json.dumps(
{
"expiresOn": datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
"accessToken": expected_token,
"subscription": "some-guid",
"tenant": expected_token,
"tokenType": "Bearer",
}
)
credential = AzureCliCredential()
with mock.patch("shutil.which", return_value="az"):
with mock.patch(CHECK_OUTPUT, fake_check_output):
token = getattr(credential, get_token_method)("scope")
assert token.token == expected_token
with mock.patch.dict("os.environ", {EnvironmentVariables.AZURE_IDENTITY_DISABLE_MULTITENANTAUTH: "true"}):
kwargs = {"tenant_id": "un" + expected_tenant}
if get_token_method == "get_token_info":
kwargs = {"options": kwargs}
token = getattr(credential, get_token_method)("scope", **kwargs)
assert token.token == expected_token
|
