Skip to content

Add challenge authentication to azure-keyvault-keys #6244

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

Merged
chlowell merged 8 commits into from
Jul 17, 2019
Merged

Add challenge authentication to azure-keyvault-keys #6244

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bb7af5a
sync challenge policy and tests
chlowell Jul 2, 2019
0d4c9e9
async challenge auth policy
chlowell Jul 3, 2019
deca639
prevent redundant challenge in paging
chlowell Jul 5, 2019
ec58a2a
auth challenge policy -> challenge auth policy
chlowell Jul 5, 2019
e29bd85
consolidate challenge code in _shared
chlowell Jul 5, 2019
5352129
test challenge cache ignores https port
chlowell Jul 5, 2019
0223642
_ChallengeAuthPolicyBase -> ChallengeAuthPolicyBase
chlowell Jul 5, 2019
80d3e49
record tests
chlowell Jul 9, 2019
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
Prev Previous commit
Next Next commit
auth challenge policy -> challenge auth policy
  • Loading branch information
@chlowell
chlowell committed Jul 9, 2019
commit ec58a2a139b68ffb7e131370c2ae349df8786baa
4 changes: 2 additions & 2 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/_internal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
except ImportError:
import urlparse as parse # pylint: disable=import-error

from .auth_challenge_policy import AuthChallengePolicy
from .challenge_auth_policy import ChallengeAuthPolicy

_VaultId = namedtuple("VaultId", ["vault_url", "collection", "name", "version"])

Expand Down Expand Up @@ -65,7 +65,7 @@ def create_config(credential, api_version=None, **kwargs):
if api_version is None:
api_version = KeyVaultClient.DEFAULT_API_VERSION
config = KeyVaultClient.get_configuration_class(api_version, aio=False)(credential, **kwargs)
config.authentication_policy = AuthChallengePolicy(credential)
config.authentication_policy = ChallengeAuthPolicy(credential)
return config

def __init__(self, vault_url, credential, config=None, transport=None, api_version=None, **kwargs):
Expand Down
4 changes: 2 additions & 2 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/_shared/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
# ------------------------------------
__all__ = [] # type: ignore
try:
from .async_auth_challenge_policy import AsyncAuthChallengePolicy
from .async_challenge_auth_policy import AsyncChallengeAuthPolicy

__all__.append("AsyncAuthChallengePolicy")
__all__.append("AsyncChallengeAuthPolicy")
except (SyntaxError, ImportError):
pass
4 changes: 2 additions & 2 deletions ...ys/_shared/async_auth_challenge_policy.py → ...ys/_shared/async_challenge_auth_policy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
from azure.core.pipeline.transport import HttpRequest, HttpResponse

from .. import http_challenge_cache as ChallengeCache
from ..auth_challenge_policy import _AuthChallengePolicyBase
from ..challenge_auth_policy import _ChallengeAuthPolicyBase
from ..http_challenge import HttpChallenge


class AsyncAuthChallengePolicy(_AuthChallengePolicyBase, AsyncHTTPPolicy):
class AsyncChallengeAuthPolicy(_ChallengeAuthPolicyBase, AsyncHTTPPolicy):
"""policy for handling HTTP authentication challenges"""

async def send(self, request: PipelineRequest) -> HttpResponse:
Expand Down
4 changes: 2 additions & 2 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/_internal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from msrest.serialization import Model

from azure.keyvault.keys._generated import KeyVaultClient
from azure.keyvault.keys._shared import AsyncAuthChallengePolicy
from azure.keyvault.keys._shared import AsyncChallengeAuthPolicy


if TYPE_CHECKING:
Expand Down Expand Up @@ -57,7 +57,7 @@ def create_config(
if api_version is None:
api_version = KeyVaultClient.DEFAULT_API_VERSION
config = KeyVaultClient.get_configuration_class(api_version, aio=True)(credential, **kwargs)
config.authentication_policy = AsyncAuthChallengePolicy(credential)
config.authentication_policy = AsyncChallengeAuthPolicy(credential)
return config

def __init__(
Expand Down
6 changes: 3 additions & 3 deletions ...re/keyvault/keys/auth_challenge_policy.py → ...re/keyvault/keys/challenge_auth_policy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
from . import http_challenge_cache as ChallengeCache


class _AuthChallengePolicyBase(_BearerTokenCredentialPolicyBase):
class _ChallengeAuthPolicyBase(_BearerTokenCredentialPolicyBase):
"""Sans I/O base for challenge authentication policies"""

def __init__(self, credential, **kwargs):
super(_AuthChallengePolicyBase, self).__init__(credential, **kwargs)
super(_ChallengeAuthPolicyBase, self).__init__(credential, **kwargs)

@staticmethod
def _update_challenge(request, challenger):
Expand All @@ -40,7 +40,7 @@ def _update_challenge(request, challenger):
return challenge


class AuthChallengePolicy(_AuthChallengePolicyBase, HTTPPolicy):
class ChallengeAuthPolicy(_ChallengeAuthPolicyBase, HTTPPolicy):
"""policy for handling HTTP authentication challenges"""

def send(self, request):
Expand Down
6 changes: 3 additions & 3 deletions sdk/keyvault/azure-keyvault-keys/tests/test_challenge_policy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from azure.core.credentials import AccessToken
from azure.core.pipeline import Pipeline
from azure.core.pipeline.transport import HttpRequest
from azure.keyvault.keys.auth_challenge_policy import AuthChallengePolicy
from azure.keyvault.keys.challenge_auth_policy import ChallengeAuthPolicy
from azure.keyvault.keys.http_challenge import HttpChallenge
import azure.keyvault.keys.http_challenge_cache as challenge_cache
import pytest
Expand Down Expand Up @@ -91,7 +91,7 @@ def get_token(*scopes):
return AccessToken(expected_token, 0)

credential = Mock(get_token=Mock(wraps=get_token))
pipeline = Pipeline(policies=[AuthChallengePolicy(credential=credential)], transport=Mock(send=send))
pipeline = Pipeline(policies=[ChallengeAuthPolicy(credential=credential)], transport=Mock(send=send))
pipeline.run(HttpRequest("POST", "https://azure.service", data=data))

assert credential.get_token.call_count == 1
Expand Down Expand Up @@ -138,7 +138,7 @@ def test_policy_updates_cache():

tokens = (t for t in [first_token] * 2 + [second_token] * 2)
credential = Mock(get_token=lambda _: AccessToken(next(tokens), 0))
pipeline = Pipeline(policies=[AuthChallengePolicy(credential=credential)], transport=transport)
pipeline = Pipeline(policies=[ChallengeAuthPolicy(credential=credential)], transport=transport)

# policy should complete and cache the first challenge
pipeline.run(HttpRequest("GET", url))
Expand Down
6 changes: 3 additions & 3 deletions sdk/keyvault/azure-keyvault-keys/tests/test_challenge_policy_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from azure.core.credentials import AccessToken
from azure.core.pipeline import AsyncPipeline
from azure.core.pipeline.transport import HttpRequest
from azure.keyvault.keys._shared import AsyncAuthChallengePolicy
from azure.keyvault.keys._shared import AsyncChallengeAuthPolicy
from azure.keyvault.keys.http_challenge import HttpChallenge
import azure.keyvault.keys.http_challenge_cache as challenge_cache
import pytest
Expand Down Expand Up @@ -63,7 +63,7 @@ async def get_token(*scopes):
return AccessToken(expected_token, 0)

credential = Mock(get_token=get_token)
pipeline = AsyncPipeline(policies=[AsyncAuthChallengePolicy(credential=credential)], transport=Mock(send=send))
pipeline = AsyncPipeline(policies=[AsyncChallengeAuthPolicy(credential=credential)], transport=Mock(send=send))
await pipeline.run(HttpRequest("POST", "https://azure.service", data=data))


Expand Down Expand Up @@ -109,7 +109,7 @@ async def test_policy_updates_cache():

tokens = (t for t in [first_token] * 2 + [second_token] * 2)
credential = Mock(get_token=asyncio.coroutine(lambda _: AccessToken(next(tokens), 0)))
pipeline = AsyncPipeline(policies=[AsyncAuthChallengePolicy(credential=credential)], transport=transport)
pipeline = AsyncPipeline(policies=[AsyncChallengeAuthPolicy(credential=credential)], transport=transport)

# policy should complete and cache the first challenge
await pipeline.run(HttpRequest("GET", url))
Expand Down