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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import sys
import time
from unittest import mock
from urllib.parse import urlparse
from azure.core.credentials import AccessToken
from azure.core.exceptions import ClientAuthenticationError
from azure.identity import AzureAuthorityHosts, CredentialUnavailableError, VisualStudioCodeCredential
from azure.core.pipeline.policies import SansIOHTTPPolicy
from azure.identity._constants import EnvironmentVariables
from azure.identity._internal.user_agent import USER_AGENT
import pytest
from helpers import build_aad_response, mock_response, Request, validating_transport
GET_REFRESH_TOKEN = VisualStudioCodeCredential.__module__ + ".get_refresh_token"
GET_USER_SETTINGS = VisualStudioCodeCredential.__module__ + ".get_user_settings"
def get_credential(user_settings=None, **kwargs):
# defaulting to empty user settings ensures tests work when real user settings are available
with mock.patch(GET_USER_SETTINGS, lambda: user_settings or {}):
return VisualStudioCodeCredential(**kwargs)
@pytest.mark.skip(reason="VS code credential is disabled")
def test_tenant_id():
def get_transport(expected_tenant):
return validating_transport(
requests=[
Request(base_url="https://{}/{}".format(AzureAuthorityHosts.AZURE_PUBLIC_CLOUD, expected_tenant))
],
responses=[mock_response(json_payload=build_aad_response(access_token="**"))],
)
# credential should default to "organizations" tenant
transport = get_transport("organizations")
credential = get_credential(transport=transport)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
assert transport.send.call_count == 1
# ... unless VS Code has a tenant configured
user_settings = {"azure.tenant": "vs-code-setting"}
transport = get_transport(user_settings["azure.tenant"])
credential = get_credential(user_settings, transport=transport)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
assert transport.send.call_count == 1
# ... and a tenant specified by the application prevails over VS Code configuration
transport = get_transport("from-application")
credential = get_credential(user_settings, tenant_id="from-application", transport=transport)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
assert transport.send.call_count == 1
@pytest.mark.skip(reason="VS code credential is disabled")
def test_tenant_id_validation():
"""The credential should raise ValueError when given an invalid tenant_id"""
valid_ids = {"c878a2ab-8ef4-413b-83a0-199afb84d7fb", "contoso.onmicrosoft.com", "organizations", "common"}
for tenant in valid_ids:
get_credential(tenant_id=tenant)
invalid_ids = {"my tenant", "my_tenant", "/", "\\", '"my-tenant"', "'my-tenant'"}
for tenant in invalid_ids:
with pytest.raises(ValueError):
get_credential(tenant_id=tenant)
@pytest.mark.skip(reason="VS code credential is disabled")
def test_no_scopes():
"""The credential should raise ValueError when get_token is called with no scopes"""
credential = get_credential()
with pytest.raises(ValueError):
credential.get_token()
@pytest.mark.skip(reason="VS code credential is disabled")
def test_policies_configurable():
policy = mock.Mock(spec_set=SansIOHTTPPolicy, on_request=mock.Mock())
def send(*_, **kwargs):
# ensure the `claims` and `tenant_id` keywords from credential's `get_token` method don't make it to transport
assert "claims" not in kwargs
assert "tenant_id" not in kwargs
return mock_response(json_payload=build_aad_response(access_token="**"))
credential = get_credential(policies=[policy], transport=mock.Mock(send=send))
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
assert policy.on_request.called
@pytest.mark.skip(reason="VS code credential is disabled")
def test_user_agent():
transport = validating_transport(
requests=[Request(required_headers={"User-Agent": USER_AGENT})],
responses=[mock_response(json_payload=build_aad_response(access_token="**"))],
)
credential = get_credential(transport=transport)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
@pytest.mark.skip(reason="VS code credential is disabled")
@pytest.mark.parametrize("authority", ("localhost", "https://localhost"))
def test_request_url(authority):
"""the credential should accept an authority, with or without scheme, as an argument or environment variable"""
tenant_id = "expected-tenant"
access_token = "***"
parsed_authority = urlparse(authority)
expected_netloc = parsed_authority.netloc or authority # "localhost" parses to netloc "", path "localhost"
expected_refresh_token = "refresh-token"
def mock_send(request, **kwargs):
actual = urlparse(request.url)
assert actual.scheme == "https"
assert actual.netloc == expected_netloc
assert actual.path.startswith("/" + tenant_id)
assert request.body["refresh_token"] == expected_refresh_token
return mock_response(json_payload={"token_type": "Bearer", "expires_in": 42, "access_token": access_token})
credential = get_credential(tenant_id=tenant_id, transport=mock.Mock(send=mock_send), authority=authority)
with mock.patch(GET_REFRESH_TOKEN, return_value=expected_refresh_token):
token = credential.get_token("scope")
assert token.token == access_token
# authority can be configured via environment variable
with mock.patch.dict("os.environ", {EnvironmentVariables.AZURE_AUTHORITY_HOST: authority}):
credential = get_credential(tenant_id=tenant_id, transport=mock.Mock(send=mock_send))
with mock.patch(GET_REFRESH_TOKEN, return_value=expected_refresh_token):
credential.get_token("scope")
assert token.token == access_token
@pytest.mark.skip(reason="VS code credential is disabled")
def test_credential_unavailable_error():
credential = get_credential()
with mock.patch(GET_REFRESH_TOKEN, return_value=None):
with pytest.raises(CredentialUnavailableError):
credential.get_token("scope")
@pytest.mark.skip(reason="VS code credential is disabled")
def test_redeem_token():
expected_token = AccessToken("token", 42)
expected_value = "value"
mock_client = mock.Mock(spec=object)
mock_client.obtain_token_by_refresh_token = mock.Mock(return_value=expected_token)
mock_client.get_cached_access_token = mock.Mock(return_value=None)
with mock.patch(GET_REFRESH_TOKEN, return_value=expected_value):
credential = get_credential(_client=mock_client)
token = credential.get_token("scope")
assert token is expected_token
mock_client.obtain_token_by_refresh_token.assert_called_with(
("scope",), expected_value, claims=None, tenant_id=None
)
assert mock_client.obtain_token_by_refresh_token.call_count == 1
@pytest.mark.skip(reason="VS code credential is disabled")
def test_cache_refresh_token():
expected_token = AccessToken("token", 42)
mock_client = mock.Mock(spec=object)
mock_client.obtain_token_by_refresh_token = mock.Mock(return_value=expected_token)
mock_client.get_cached_access_token = mock.Mock(return_value=None)
mock_get_credentials = mock.Mock(return_value="VALUE")
with mock.patch(GET_REFRESH_TOKEN, mock_get_credentials):
credential = get_credential(_client=mock_client)
token = credential.get_token("scope")
assert token is expected_token
assert mock_get_credentials.call_count == 1
token = credential.get_token("scope")
assert token is expected_token
assert mock_get_credentials.call_count == 1
@pytest.mark.skip(reason="VS code credential is disabled")
def test_no_obtain_token_if_cached():
expected_token = AccessToken("token", time.time() + 3600)
mock_client = mock.Mock(
obtain_token_by_refresh_token=mock.Mock(return_value=expected_token),
get_cached_access_token=mock.Mock(return_value=expected_token),
)
credential = get_credential(_client=mock_client)
with mock.patch(
GET_REFRESH_TOKEN,
mock.Mock(side_effect=Exception("credential should not acquire a new token")),
):
token = credential.get_token("scope")
assert mock_client.obtain_token_by_refresh_token.call_count == 0
assert token.token == expected_token.token
assert token.expires_on == expected_token.expires_on
@pytest.mark.skip(reason="VS code credential is disabled")
def test_native_adapter():
"""Exercise the native adapter for the current OS"""
if sys.platform.startswith("darwin"):
from azure.identity._internal.macos_vscode_adapter import get_refresh_token
elif sys.platform.startswith("linux"):
from azure.identity._internal.linux_vscode_adapter import get_refresh_token
elif sys.platform.startswith("win"):
from azure.identity._internal.win_vscode_adapter import get_refresh_token
else:
pytest.skip('unsupported platform "{}"'.format(sys.platform))
# the return value (None in CI, possibly something else on a dev machine) is irrelevant
# because the goal is simply to expose a native interop problem like a segfault
get_refresh_token("AzureCloud")
@pytest.mark.skip(reason="VS code credential is disabled")
def test_adfs():
"""The credential should raise CredentialUnavailableError when configured for ADFS"""
credential = get_credential(tenant_id="adfs")
with pytest.raises(CredentialUnavailableError) as ex:
credential.get_token("scope")
assert "adfs" in ex.value.message.lower()
@pytest.mark.skip(reason="VS code credential is disabled")
def test_custom_cloud_no_authority():
"""The credential is unavailable when VS Code is configured to use a custom cloud with no known authority"""
cloud_name = "AzureCustomCloud"
credential = get_credential({"azure.cloud": cloud_name})
with pytest.raises(CredentialUnavailableError, match="authority.*" + cloud_name):
credential.get_token("scope")
@pytest.mark.skip(reason="VS code credential is disabled")
@pytest.mark.parametrize(
"cloud,authority",
(
("AzureCloud", AzureAuthorityHosts.AZURE_PUBLIC_CLOUD),
("AzureChinaCloud", AzureAuthorityHosts.AZURE_CHINA),
("AzureUSGovernment", AzureAuthorityHosts.AZURE_GOVERNMENT),
),
)
def test_reads_cloud_settings(cloud, authority):
"""the credential should read authority and tenant from VS Code settings when an application doesn't specify them"""
expected_tenant = "tenant-id"
user_settings = {"azure.cloud": cloud, "azure.tenant": expected_tenant}
transport = validating_transport(
requests=[Request(base_url="https://{}/{}".format(authority, expected_tenant))],
responses=[mock_response(json_payload=build_aad_response(access_token="**"))],
)
credential = get_credential(user_settings, transport=transport)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
assert transport.send.call_count == 1
@pytest.mark.skip(reason="VS code credential is disabled")
def test_no_user_settings():
"""the credential should default to Public Cloud and "organizations" tenant when it can't read VS Code settings"""
transport = validating_transport(
requests=[Request(base_url="https://{}/{}".format(AzureAuthorityHosts.AZURE_PUBLIC_CLOUD, "organizations"))],
responses=[mock_response(json_payload=build_aad_response(access_token="**"))],
)
credential = get_credential(transport=transport)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
credential.get_token("scope")
assert transport.send.call_count == 1
@pytest.mark.skip(reason="VS code credential is disabled")
def test_multitenant_authentication():
first_tenant = "first-tenant"
first_token = "***"
second_tenant = "second-tenant"
second_token = first_token * 2
def send(request, **kwargs):
# ensure the `claims` and `tenant_id` keywords from credential's `get_token` method don't make it to transport
assert "claims" not in kwargs
assert "tenant_id" not in kwargs
parsed = urlparse(request.url)
tenant = parsed.path.split("/")[1]
assert tenant in (first_tenant, second_tenant), 'unexpected tenant "{}"'.format(tenant)
token = first_token if tenant == first_tenant else second_token
return mock_response(json_payload=build_aad_response(access_token=token))
credential = get_credential(
tenant_id=first_tenant, transport=mock.Mock(send=send), additionally_allowed_tenants=["*"]
)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
token = credential.get_token("scope")
assert token.token == first_token
token = credential.get_token("scope", tenant_id=first_tenant)
assert token.token == first_token
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
token = credential.get_token("scope", tenant_id=second_tenant)
assert token.token == second_token
# should still default to the first tenant
token = credential.get_token("scope")
assert token.token == first_token
@pytest.mark.skip(reason="VS code credential is disabled")
def test_multitenant_authentication_not_allowed():
expected_tenant = "expected-tenant"
expected_token = "***"
def send(request, **kwargs):
# ensure the `claims` and `tenant_id` keywords from credential's `get_token` method don't make it to transport
assert "claims" not in kwargs
assert "tenant_id" not in kwargs
parsed = urlparse(request.url)
tenant = parsed.path.split("/")[1]
token = expected_token if tenant == expected_tenant else expected_token * 2
return mock_response(json_payload=build_aad_response(access_token=token))
credential = get_credential(
tenant_id=expected_tenant, transport=mock.Mock(send=send), additionally_allowed_tenants=["*"]
)
with mock.patch(GET_REFRESH_TOKEN, lambda _: "**"):
token = credential.get_token("scope")
assert token.token == expected_token
token = credential.get_token("scope", tenant_id=expected_tenant)
assert token.token == expected_token
token = credential.get_token("scope", tenant_id="un" + expected_tenant)
assert token.token == expected_token * 2
with mock.patch.dict("os.environ", {EnvironmentVariables.AZURE_IDENTITY_DISABLE_MULTITENANTAUTH: "true"}):
token = credential.get_token("scope", tenant_id="un" + expected_tenant)
assert token.token == expected_token
def test_deprecation_warning():
with pytest.deprecated_call():
get_credential()
|