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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE.txt in the project root for
# license information.
# -------------------------------------------------------------------------
import time
from itertools import product
import azure.core
from azure.core.credentials import AccessToken, AzureKeyCredential, AzureSasCredential, AzureNamedKeyCredential
from azure.core.exceptions import ServiceRequestError
from azure.core.pipeline import Pipeline
from azure.core.pipeline.policies import (
BearerTokenCredentialPolicy,
SansIOHTTPPolicy,
AzureKeyCredentialPolicy,
AzureSasCredentialPolicy,
)
from utils import HTTP_REQUESTS
import pytest
from unittest.mock import Mock
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_adds_header(http_request):
"""The bearer token policy should add a header containing a token from its credential"""
# 2524608000 == 01/01/2050 @ 12:00am (UTC)
expected_token = AccessToken("expected_token", 2524608000)
def verify_authorization_header(request):
assert request.http_request.headers["Authorization"] == "Bearer {}".format(expected_token.token)
return Mock()
fake_credential = Mock(get_token=Mock(return_value=expected_token))
policies = [BearerTokenCredentialPolicy(fake_credential, "scope"), Mock(send=verify_authorization_header)]
pipeline = Pipeline(transport=Mock(), policies=policies)
pipeline.run(http_request("GET", "https://spam.eggs"))
assert fake_credential.get_token.call_count == 1
pipeline.run(http_request("GET", "https://spam.eggs"))
# Didn't need a new token
assert fake_credential.get_token.call_count == 1
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_send(http_request):
"""The bearer token policy should invoke the next policy's send method and return the result"""
expected_request = http_request("GET", "https://spam.eggs")
expected_response = Mock()
def verify_request(request):
assert request.http_request is expected_request
return expected_response
fake_credential = Mock(get_token=lambda _: AccessToken("", 0))
policies = [BearerTokenCredentialPolicy(fake_credential, "scope"), Mock(send=verify_request)]
response = Pipeline(transport=Mock(), policies=policies).run(expected_request)
assert response is expected_response
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_token_caching(http_request):
good_for_one_hour = AccessToken("token", time.time() + 3600)
credential = Mock(get_token=Mock(return_value=good_for_one_hour))
pipeline = Pipeline(transport=Mock(), policies=[BearerTokenCredentialPolicy(credential, "scope")])
pipeline.run(http_request("GET", "https://spam.eggs"))
assert credential.get_token.call_count == 1 # policy has no token at first request -> it should call get_token
pipeline.run(http_request("GET", "https://spam.eggs"))
assert credential.get_token.call_count == 1 # token is good for an hour -> policy should return it from cache
expired_token = AccessToken("token", time.time())
credential.get_token.reset_mock()
credential.get_token.return_value = expired_token
pipeline = Pipeline(transport=Mock(), policies=[BearerTokenCredentialPolicy(credential, "scope")])
pipeline.run(http_request("GET", "https://spam.eggs"))
assert credential.get_token.call_count == 1
pipeline.run(http_request("GET", "https://spam.eggs"))
assert credential.get_token.call_count == 2 # token expired -> policy should call get_token
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_optionally_enforces_https(http_request):
"""HTTPS enforcement should be controlled by a keyword argument, and enabled by default"""
def assert_option_popped(request, **kwargs):
assert "enforce_https" not in kwargs, "BearerTokenCredentialPolicy didn't pop the 'enforce_https' option"
return Mock()
credential = Mock(get_token=lambda *_, **__: AccessToken("***", 42))
pipeline = Pipeline(
transport=Mock(send=assert_option_popped), policies=[BearerTokenCredentialPolicy(credential, "scope")]
)
# by default and when enforce_https=True, the policy should raise when given an insecure request
with pytest.raises(ServiceRequestError):
pipeline.run(http_request("GET", "http://not.secure"))
with pytest.raises(ServiceRequestError):
pipeline.run(http_request("GET", "http://not.secure"), enforce_https=True)
# when enforce_https=False, an insecure request should pass
pipeline.run(http_request("GET", "http://not.secure"), enforce_https=False)
# https requests should always pass
pipeline.run(http_request("GET", "https://secure"), enforce_https=False)
pipeline.run(http_request("GET", "https://secure"), enforce_https=True)
pipeline.run(http_request("GET", "https://secure"))
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_preserves_enforce_https_opt_out(http_request):
"""The policy should use request context to preserve an opt out from https enforcement"""
class ContextValidator(SansIOHTTPPolicy):
def on_request(self, request):
assert "enforce_https" in request.context, "'enforce_https' is not in the request's context"
return Mock()
credential = Mock(get_token=Mock(return_value=AccessToken("***", 42)))
policies = [BearerTokenCredentialPolicy(credential, "scope"), ContextValidator()]
pipeline = Pipeline(transport=Mock(), policies=policies)
pipeline.run(http_request("GET", "http://not.secure"), enforce_https=False)
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_default_context(http_request):
"""The policy should call get_token with the scopes given at construction, and no keyword arguments, by default"""
expected_scope = "scope"
token = AccessToken("", 0)
credential = Mock(get_token=Mock(return_value=token))
policy = BearerTokenCredentialPolicy(credential, expected_scope)
pipeline = Pipeline(transport=Mock(), policies=[policy])
pipeline.run(http_request("GET", "https://localhost"))
credential.get_token.assert_called_once_with(expected_scope)
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_context_unmodified_by_default(http_request):
"""When no options for the policy accompany a request, the policy shouldn't add anything to the request context"""
class ContextValidator(SansIOHTTPPolicy):
def on_request(self, request):
assert not any(request.context), "the policy shouldn't add to the request's context"
credential = Mock(get_token=Mock(return_value=AccessToken("***", 42)))
policies = [BearerTokenCredentialPolicy(credential, "scope"), ContextValidator()]
pipeline = Pipeline(transport=Mock(), policies=policies)
pipeline.run(http_request("GET", "https://secure"))
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_calls_on_challenge(http_request):
"""BearerTokenCredentialPolicy should call its on_challenge method when it receives an authentication challenge"""
class TestPolicy(BearerTokenCredentialPolicy):
called = False
def on_challenge(self, request, challenge):
self.__class__.called = True
return False
credential = Mock(get_token=Mock(return_value=AccessToken("***", int(time.time()) + 3600)))
policies = [TestPolicy(credential, "scope")]
response = Mock(status_code=401, headers={"WWW-Authenticate": 'Basic realm="localhost"'})
transport = Mock(send=Mock(return_value=response))
pipeline = Pipeline(transport=transport, policies=policies)
pipeline.run(http_request("GET", "https://localhost"))
assert TestPolicy.called
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_cannot_complete_challenge(http_request):
"""BearerTokenCredentialPolicy should return the 401 response when it can't complete its challenge"""
expected_scope = "scope"
expected_token = AccessToken("***", int(time.time()) + 3600)
credential = Mock(get_token=Mock(return_value=expected_token))
expected_response = Mock(status_code=401, headers={"WWW-Authenticate": 'Basic realm="localhost"'})
transport = Mock(send=Mock(return_value=expected_response))
policies = [BearerTokenCredentialPolicy(credential, expected_scope)]
pipeline = Pipeline(transport=transport, policies=policies)
response = pipeline.run(http_request("GET", "https://localhost"))
assert response.http_response is expected_response
assert transport.send.call_count == 1
credential.get_token.assert_called_once_with(expected_scope)
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_bearer_policy_calls_sansio_methods(http_request):
"""BearerTokenCredentialPolicy should call SansIOHttpPolicy methods as does _SansIOHTTPPolicyRunner"""
class TestPolicy(BearerTokenCredentialPolicy):
def __init__(self, *args, **kwargs):
super(TestPolicy, self).__init__(*args, **kwargs)
self.on_exception = Mock(return_value=False)
self.on_request = Mock()
self.on_response = Mock()
def send(self, request):
self.request = request
self.response = super(TestPolicy, self).send(request)
return self.response
credential = Mock(get_token=Mock(return_value=AccessToken("***", int(time.time()) + 3600)))
policy = TestPolicy(credential, "scope")
transport = Mock(send=Mock(return_value=Mock(status_code=200)))
pipeline = Pipeline(transport=transport, policies=[policy])
pipeline.run(http_request("GET", "https://localhost"))
policy.on_request.assert_called_once_with(policy.request)
policy.on_response.assert_called_once_with(policy.request, policy.response)
# the policy should call on_exception when next.send() raises
class TestException(Exception):
pass
# during the first send...
transport = Mock(send=Mock(side_effect=TestException))
policy = TestPolicy(credential, "scope")
pipeline = Pipeline(transport=transport, policies=[policy])
with pytest.raises(TestException):
pipeline.run(http_request("GET", "https://localhost"))
policy.on_exception.assert_called_once_with(policy.request)
# ...or the second
def raise_the_second_time(*args, **kwargs):
if raise_the_second_time.calls == 0:
raise_the_second_time.calls = 1
return Mock(status_code=401, headers={"WWW-Authenticate": 'Basic realm="localhost"'})
raise TestException()
raise_the_second_time.calls = 0
policy = TestPolicy(credential, "scope")
policy.on_challenge = Mock(return_value=True)
transport = Mock(send=Mock(wraps=raise_the_second_time))
pipeline = Pipeline(transport=transport, policies=[policy])
with pytest.raises(TestException):
pipeline.run(http_request("GET", "https://localhost"))
assert transport.send.call_count == 2
policy.on_challenge.assert_called_once()
policy.on_exception.assert_called_once_with(policy.request)
@pytest.mark.skipif(azure.core.__version__ >= "2", reason="this test applies only to azure-core 1.x")
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_key_vault_regression(http_request):
"""Test for regression affecting azure-keyvault-* 4.0.0. This test must pass, unmodified, for all 1.x versions."""
from azure.core.pipeline.policies._authentication import _BearerTokenCredentialPolicyBase
credential = Mock()
policy = _BearerTokenCredentialPolicyBase(credential)
assert policy._credential is credential
headers = {}
token = "alphanums" # cspell:disable-line
policy._update_headers(headers, token)
assert headers["Authorization"] == "Bearer " + token
assert policy._need_new_token
policy._token = AccessToken(token, time.time() + 3600)
assert not policy._need_new_token
assert policy._token.token == token
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_azure_key_credential_policy(http_request):
"""Tests to see if we can create an AzureKeyCredentialPolicy"""
key_header = "api_key"
api_key = "test_key"
def verify_authorization_header(request):
assert request.headers[key_header] == api_key
transport = Mock(send=verify_authorization_header)
credential = AzureKeyCredential(api_key)
credential_policy = AzureKeyCredentialPolicy(credential=credential, name=key_header)
pipeline = Pipeline(transport=transport, policies=[credential_policy])
pipeline.run(http_request("GET", "https://test_key_credential"))
def test_azure_key_credential_policy_raises():
"""Tests AzureKeyCredential and AzureKeyCredentialPolicy raises with non-string input parameters."""
api_key = 1234
key_header = 5678
with pytest.raises(TypeError):
credential = AzureKeyCredential(api_key)
credential = AzureKeyCredential(str(api_key))
with pytest.raises(TypeError):
credential_policy = AzureKeyCredentialPolicy(credential=credential, name=key_header)
def test_azure_key_credential_updates():
"""Tests AzureKeyCredential updates"""
api_key = "original"
credential = AzureKeyCredential(api_key)
assert credential.key == api_key
api_key = "new"
credential.update(api_key)
assert credential.key == api_key
combinations = [
("sig=test_signature", "https://test_sas_credential", "https://test_sas_credential?sig=test_signature"),
("?sig=test_signature", "https://test_sas_credential", "https://test_sas_credential?sig=test_signature"),
("sig=test_signature", "https://test_sas_credential?sig=test_signature", "https://test_sas_credential?sig=test_signature"),
("?sig=test_signature", "https://test_sas_credential?sig=test_signature", "https://test_sas_credential?sig=test_signature"),
("sig=test_signature", "https://test_sas_credential?", "https://test_sas_credential?sig=test_signature"),
("?sig=test_signature", "https://test_sas_credential?", "https://test_sas_credential?sig=test_signature"),
("sig=test_signature", "https://test_sas_credential?foo=bar", "https://test_sas_credential?foo=bar&sig=test_signature"),
("?sig=test_signature", "https://test_sas_credential?foo=bar", "https://test_sas_credential?foo=bar&sig=test_signature"),
]
@pytest.mark.parametrize("combinations,http_request", product(combinations, HTTP_REQUESTS))
def test_azure_sas_credential_policy(combinations, http_request):
"""Tests to see if we can create an AzureSasCredentialPolicy"""
sas, url, expected_url = combinations
def verify_authorization(request):
assert request.url == expected_url
transport=Mock(send=verify_authorization)
credential = AzureSasCredential(sas)
credential_policy = AzureSasCredentialPolicy(credential=credential)
pipeline = Pipeline(transport=transport, policies=[credential_policy])
pipeline.run(http_request("GET", url))
def test_azure_sas_credential_updates():
"""Tests AzureSasCredential updates"""
sas = "original"
credential = AzureSasCredential(sas)
assert credential.signature == sas
sas = "new"
credential.update(sas)
assert credential.signature == sas
def test_azure_sas_credential_policy_raises():
"""Tests AzureSasCredential and AzureSasCredentialPolicy raises with non-string input parameters."""
sas = 1234
with pytest.raises(TypeError):
credential = AzureSasCredential(sas)
def test_azure_named_key_credential():
cred = AzureNamedKeyCredential("sample_name", "samplekey")
assert cred.named_key.name == "sample_name"
assert cred.named_key.key == "samplekey"
assert isinstance(cred.named_key, tuple)
cred.update("newname", "newkey")
assert cred.named_key.name == "newname"
assert cred.named_key.key == "newkey"
assert isinstance(cred.named_key, tuple)
def test_azure_named_key_credential_raises():
with pytest.raises(TypeError, match="Both name and key must be strings."):
cred = AzureNamedKeyCredential("sample_name", 123345)
cred = AzureNamedKeyCredential("sample_name", "samplekey")
assert cred.named_key.name == "sample_name"
assert cred.named_key.key == "samplekey"
with pytest.raises(TypeError, match="Both name and key must be strings."):
cred.update(1234, "newkey")
|