Skip to content

[Key Vault] Ensure challenge resource matching is case- and trailing slash-insensitive #43198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[Key Vault] Ensure challenge resource matching is case- and trailing slash-insensitive #43198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59fe2ad
Add regression test case
mccoyp Sep 30, 2025
8ea565e
Remove import
mccoyp Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 31 additions & 18 deletions sdk/keyvault/azure-keyvault-keys/tests/test_challenge_auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,8 @@ def test_verify_challenge_resource_matches(verify_challenge_resource, token_type

url = get_random_url()
url_with_port = add_url_port(url)
url_with_caps = "https://MY_KV_NAME.MYVAULT.azure.net"
url_with_slash = "https://my_kv_name.myvault.azure.net/"
token = "**"
resource = "https://myvault.azure.net" # Doesn't match a "".vault.azure.net" resource because of the "my" prefix

Expand All @@ -542,29 +544,40 @@ def get_token(*_, **__):
else:
credential = Mock(spec_set=["get_token_info"], get_token_info=Mock(wraps=get_token))

transport = validating_transport(
requests=[Request(), Request(required_headers={"Authorization": f"Bearer {token}"})],
responses=[
mock_response(
status_code=401, headers={"WWW-Authenticate": f'Bearer authorization="{url}", resource={resource}'}
),
mock_response(status_code=200, json_payload={"key": {"kid": f"{url}/key-name"}})
]
)
transport_2 = validating_transport(
requests=[Request(), Request(required_headers={"Authorization": f"Bearer {token}"})],
responses=[
mock_response(
status_code=401, headers={"WWW-Authenticate": f'Bearer authorization="{url}", resource={resource}'}
),
mock_response(status_code=200, json_payload={"key": {"kid": f"{url}/key-name"}})
]
)
def get_transport():
return validating_transport(
requests=[Request(), Request(required_headers={"Authorization": f"Bearer {token}"})],
responses=[
mock_response(
status_code=401, headers={"WWW-Authenticate": f'Bearer authorization="{url}", resource={resource}'}
),
mock_response(status_code=200, json_payload={"key": {"kid": f"{url}/key-name"}})
]
)

transport = get_transport()
transport_2 = get_transport()
transport_3 = get_transport()
transport_4 = get_transport()

client = KeyClient(url, credential, transport=transport, verify_challenge_resource=verify_challenge_resource)
client_with_port = KeyClient(
url_with_port, credential, transport=transport_2, verify_challenge_resource=verify_challenge_resource
)
client_with_caps = KeyClient(
url_with_caps, credential, transport=transport_3, verify_challenge_resource=verify_challenge_resource
)
client_with_slash = KeyClient(
url_with_slash, credential, transport=transport_4, verify_challenge_resource=verify_challenge_resource
)

# Regression tests for https://github.com/Azure/azure-sdk-for-python/issues/42964
# Resource matching should be case insensitive since service calls would otherwise succeed
# Resource matching should ignore a trailing slash since service calls would otherwise succeed
key = client_with_caps.get_key("key-name")
assert key.name == "key-name"
key = client_with_slash.get_key("key-name")
assert key.name == "key-name"

if verify_challenge_resource:
with pytest.raises(ValueError) as e:
Expand Down
49 changes: 31 additions & 18 deletions sdk/keyvault/azure-keyvault-keys/tests/test_challenge_auth_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,8 @@ async def test_verify_challenge_resource_matches(verify_challenge_resource, toke

url = get_random_url()
url_with_port = add_url_port(url)
url_with_caps = "https://MY_KV_NAME.MYVAULT.azure.net"
url_with_slash = "https://my_kv_name.myvault.azure.net/"
token = "**"
resource = "https://myvault.azure.net" # Doesn't match a "".vault.azure.net" resource because of the "my" prefix

Expand All @@ -490,29 +492,40 @@ async def get_token(*_, **__):
else:
credential = Mock(spec_set=["get_token_info"], get_token_info=Mock(wraps=get_token))

transport = async_validating_transport(
requests=[Request(), Request(required_headers={"Authorization": f"Bearer {token}"})],
responses=[
mock_response(
status_code=401, headers={"WWW-Authenticate": f'Bearer authorization="{url}", resource={resource}'}
),
mock_response(status_code=200, json_payload={"key": {"kid": f"{url}/key-name"}})
]
)
transport_2 = async_validating_transport(
requests=[Request(), Request(required_headers={"Authorization": f"Bearer {token}"})],
responses=[
mock_response(
status_code=401, headers={"WWW-Authenticate": f'Bearer authorization="{url}", resource={resource}'}
),
mock_response(status_code=200, json_payload={"key": {"kid": f"{url}/key-name"}})
]
)
def get_transport():
return async_validating_transport(
requests=[Request(), Request(required_headers={"Authorization": f"Bearer {token}"})],
responses=[
mock_response(
status_code=401, headers={"WWW-Authenticate": f'Bearer authorization="{url}", resource={resource}'}
),
mock_response(status_code=200, json_payload={"key": {"kid": f"{url}/key-name"}})
]
)

transport = get_transport()
transport_2 = get_transport()
transport_3 = get_transport()
transport_4 = get_transport()

client = KeyClient(url, credential, transport=transport, verify_challenge_resource=verify_challenge_resource)
client_with_port = KeyClient(
url_with_port, credential, transport=transport_2, verify_challenge_resource=verify_challenge_resource
)
client_with_caps = KeyClient(
url_with_caps, credential, transport=transport_3, verify_challenge_resource=verify_challenge_resource
)
client_with_slash = KeyClient(
url_with_slash, credential, transport=transport_4, verify_challenge_resource=verify_challenge_resource
)

# Regression test for https://github.com/Azure/azure-sdk-for-python/issues/42964
# Resource matching should be case insensitive since service calls would otherwise succeed
# Resource matching should ignore a trailing slash since service calls would otherwise succeed
key = await client_with_caps.get_key("key-name")
assert key.name == "key-name"
key = await client_with_slash.get_key("key-name")
assert key.name == "key-name"

if verify_challenge_resource:
with pytest.raises(ValueError) as e:
Expand Down
Loading