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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import os
from itertools import product
from unittest.mock import Mock, patch
from azure.core.pipeline.policies import ContentDecodePolicy, SansIOHTTPPolicy
from azure.identity import OnBehalfOfCredential, UsernamePasswordCredential
from azure.identity._constants import EnvironmentVariables
from azure.identity._internal.aad_client_base import JWT_BEARER_ASSERTION
from azure.identity._internal.user_agent import USER_AGENT
import pytest
from urllib.parse import urlparse
from helpers import build_aad_response, FAKE_CLIENT_ID, get_discovery_response, mock_response, GET_TOKEN_METHODS
from recorded_test_case import RecordedTestCase
from test_certificate_credential import PEM_CERT_PATH
from devtools_testutils import is_live, recorded_by_proxy
missing_variables = [
var
for var in (
"OBO_CERT_BYTES",
"OBO_CLIENT_ID",
"OBO_CLIENT_SECRET",
"OBO_PASSWORD",
"OBO_SCOPE",
"OBO_TENANT_ID",
"OBO_USERNAME",
)
if var not in os.environ
]
class TestObo(RecordedTestCase):
def load_settings(self):
if is_live():
self.obo_settings = {
"cert_bytes": os.environ["OBO_CERT_BYTES"],
"client_id": os.environ["OBO_CLIENT_ID"],
"client_secret": os.environ["OBO_CLIENT_SECRET"],
"password": os.environ["OBO_PASSWORD"],
"scope": os.environ["OBO_SCOPE"],
"tenant_id": os.environ["OBO_TENANT_ID"],
"username": os.environ["OBO_USERNAME"],
}
else:
self.obo_settings = {
"cert_bytes": open(PEM_CERT_PATH, "rb").read(),
"client_id": FAKE_CLIENT_ID,
"client_secret": "secret",
"password": "fake-password",
"scope": "api://scope",
"tenant_id": "tenant",
"username": "username",
}
@pytest.mark.manual
@pytest.mark.skipif(any(missing_variables), reason="No value for environment variables")
@recorded_by_proxy
def test_obo(self):
self.load_settings()
client_id = self.obo_settings["client_id"]
tenant_id = self.obo_settings["tenant_id"]
user_credential = UsernamePasswordCredential(
client_id, self.obo_settings["username"], self.obo_settings["password"], tenant_id=tenant_id
)
assertion = user_credential.get_token(self.obo_settings["scope"]).token
credential = OnBehalfOfCredential(
tenant_id, client_id, client_secret=self.obo_settings["client_secret"], user_assertion=assertion
)
credential.get_token(self.obo_settings["scope"])
@pytest.mark.manual
@pytest.mark.skipif(any(missing_variables), reason="No value for environment variables")
@recorded_by_proxy
def test_obo_cert(self):
self.load_settings()
client_id = self.obo_settings["client_id"]
tenant_id = self.obo_settings["tenant_id"]
user_credential = UsernamePasswordCredential(
client_id, self.obo_settings["username"], self.obo_settings["password"], tenant_id=tenant_id
)
assertion = user_credential.get_token(self.obo_settings["scope"]).token
credential = OnBehalfOfCredential(
tenant_id, client_id, client_certificate=self.obo_settings["cert_bytes"], user_assertion=assertion
)
credential.get_token(self.obo_settings["scope"])
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_multitenant_authentication(get_token_method):
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
assert request.headers["User-Agent"].startswith(USER_AGENT)
parsed = urlparse(request.url)
tenant = parsed.path.split("/")[1]
assert tenant in (first_tenant, second_tenant), 'unexpected tenant "{}"'.format(tenant)
if "/oauth2/v2.0/token" not in parsed.path:
return get_discovery_response("https://{}/{}".format(parsed.netloc, tenant))
token = first_token if tenant == first_tenant else second_token
return mock_response(json_payload=build_aad_response(access_token=token))
transport = Mock(send=Mock(wraps=send))
credential = OnBehalfOfCredential(
first_tenant,
"client-id",
client_secret="secret",
user_assertion="assertion",
transport=transport,
additionally_allowed_tenants=["*"],
)
token = getattr(credential, get_token_method)("scope")
assert token.token == first_token
kwargs = {"tenant_id": first_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("authority,get_token_method", product(("localhost", "https://localhost"), GET_TOKEN_METHODS))
def test_authority(authority, get_token_method):
"""the credential should accept an authority, with or without scheme, as an argument or environment variable"""
tenant_id = "expected-tenant"
parsed_authority = urlparse(authority)
expected_netloc = parsed_authority.netloc or authority
expected_authority = "https://{}/{}".format(expected_netloc, tenant_id)
mock_ctor = Mock(
return_value=Mock(acquire_token_on_behalf_of=lambda *_, **__: {"access_token": "**", "expires_in": 42})
)
credential = OnBehalfOfCredential(
tenant_id, "client-id", client_secret="secret", user_assertion="assertion", authority=authority
)
with patch("msal.ConfidentialClientApplication", mock_ctor):
# must call get_token because the credential constructs the MSAL application lazily
getattr(credential, get_token_method)("scope")
assert mock_ctor.call_count == 1
_, kwargs = mock_ctor.call_args
assert kwargs["authority"] == expected_authority
mock_ctor.reset_mock()
# authority can be configured via environment variable
with patch.dict("os.environ", {EnvironmentVariables.AZURE_AUTHORITY_HOST: authority}, clear=True):
credential = OnBehalfOfCredential(tenant_id, "client-id", client_secret="secret", user_assertion="assertion")
with patch("msal.ConfidentialClientApplication", mock_ctor):
getattr(credential, get_token_method)("scope")
assert mock_ctor.call_count == 1
_, kwargs = mock_ctor.call_args
assert kwargs["authority"] == expected_authority
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:
OnBehalfOfCredential(tenant, "client-id", client_secret="secret", user_assertion="assertion")
invalid_ids = {"my tenant", "my_tenant", "/", "\\", '"my-tenant"', "'my-tenant'"}
for tenant in invalid_ids:
with pytest.raises(ValueError):
OnBehalfOfCredential(tenant, "client-id", client_secret="secret", user_assertion="assertion")
@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"""
credential = OnBehalfOfCredential(
"tenant-id", "client-id", client_secret="client-secret", user_assertion="assertion"
)
with pytest.raises(ValueError):
getattr(credential, get_token_method)()
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_policies_configurable(get_token_method):
policy = Mock(spec_set=SansIOHTTPPolicy, on_request=Mock(), on_exception=lambda _: False)
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]
if "/oauth2/v2.0/token" not in parsed.path:
return get_discovery_response("https://{}/{}".format(parsed.netloc, tenant))
return mock_response(json_payload=build_aad_response(access_token="***"))
credential = OnBehalfOfCredential(
"tenant-id",
"client-id",
client_secret="client-secret",
user_assertion="assertion",
policies=[ContentDecodePolicy(), policy],
transport=Mock(send=send),
)
getattr(credential, get_token_method)("scope")
assert policy.on_request.called
def test_no_user_assertion():
"""The credential should raise ValueError when ctoring with no user_assertion"""
with pytest.raises(TypeError):
credential = OnBehalfOfCredential("tenant-id", "client-id", client_secret="client-secret")
def test_no_client_credential():
"""The credential should raise ValueError when ctoring with no client_secret or client_certificate"""
with pytest.raises(TypeError):
credential = OnBehalfOfCredential("tenant-id", "client-id", user_assertion="assertion")
@pytest.mark.parametrize("get_token_method", GET_TOKEN_METHODS)
def test_client_assertion_func(get_token_method):
"""The credential should accept a client_assertion_func"""
expected_client_assertion = "client-assertion"
expected_user_assertion = "user-assertion"
expected_token = "***"
func_call_count = 0
def client_assertion_func():
nonlocal func_call_count
func_call_count += 1
return expected_client_assertion
def send(request, **kwargs):
parsed = urlparse(request.url)
tenant = parsed.path.split("/")[1]
if "/oauth2/v2.0/token" not in parsed.path:
return get_discovery_response("https://{}/{}".format(parsed.netloc, tenant))
assert request.data.get("client_assertion") == expected_client_assertion
assert request.data.get("client_assertion_type") == JWT_BEARER_ASSERTION
assert request.data.get("assertion") == expected_user_assertion
return mock_response(json_payload=build_aad_response(access_token=expected_token))
transport = Mock(send=Mock(wraps=send))
credential = OnBehalfOfCredential(
"tenant-id",
"client-id",
client_assertion_func=client_assertion_func,
user_assertion=expected_user_assertion,
transport=transport,
)
access_token = getattr(credential, get_token_method)("scope")
assert access_token.token == expected_token
assert func_call_count == 1
def test_client_assertion_func_with_client_certificate():
"""The credential should raise ValueError when ctoring with both client_assertion_func and client_certificate"""
with pytest.raises(ValueError) as ex:
credential = OnBehalfOfCredential(
"tenant-id",
"client-id",
client_assertion_func=lambda: "client-assertion",
client_certificate=b"certificate",
user_assertion="assertion",
)
assert "It is invalid to specify more than one of the following" in str(ex.value)
def test_client_certificate_with_params():
"""Ensure keyword arguments are passed to get_client_credential when client_certificate is provided"""
expected_send_certificate_chain = True
cert_path = os.path.join(os.path.dirname(__file__), "certificate-with-password.pem")
cert_password = "password"
with open(cert_path, "rb") as f:
cert_bytes = f.read()
credential = OnBehalfOfCredential(
"tenant-id",
"client-id",
client_certificate=cert_bytes,
password=cert_password,
send_certificate_chain=expected_send_certificate_chain,
user_assertion="assertion",
)
assert "passphrase" in credential._client_credential
assert credential._client_credential["passphrase"] == cert_password.encode("utf-8")
assert "public_certificate" in credential._client_credential
|