Skip to content
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

Jump to bottom

[Identity] Let GetTokenMixin.get_token pass kwargs to MSAL #16397

Closed
wants to merge 2 commits into from
Closed

[Identity] Let GetTokenMixin.get_token pass kwargs to MSAL #16397

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
c62486b
Let GetTokenMixin.get_token pass kwargs to MSAL
jiasli Jan 28, 2021
36b0064
linter
jiasli Jan 29, 2021
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
6 changes: 3 additions & 3 deletions sdk/identity/azure-identity/azure/identity/_credentials/app_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ def get_token(self, *scopes, **kwargs):
)
return super(AppServiceCredential, self).get_token(*scopes, **kwargs)

def _acquire_token_silently(self, *scopes):
# type: (*str) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes)
def _acquire_token_silently(self, *scopes, **kwargs):
# type: (*str, **Any) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes, **kwargs)

def _request_token(self, *scopes, **kwargs):
# type: (*str, **Any) -> AccessToken
Expand Down
6 changes: 3 additions & 3 deletions sdk/identity/azure-identity/azure/identity/_credentials/azure_arc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ def get_token(self, *scopes, **kwargs):
)
return super(AzureArcCredential, self).get_token(*scopes, **kwargs)

def _acquire_token_silently(self, *scopes):
# type: (*str) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes)
def _acquire_token_silently(self, *scopes, **kwargs):
# type: (*str, **Any) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes, **kwargs)

def _request_token(self, *scopes, **kwargs):
# type: (*str, **Any) -> AccessToken
Expand Down
6 changes: 3 additions & 3 deletions sdk/identity/azure-identity/azure/identity/_credentials/cloud_shell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ def get_token(self, *scopes, **kwargs):
)
return super(CloudShellCredential, self).get_token(*scopes, **kwargs)

def _acquire_token_silently(self, *scopes):
# type: (*str) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes)
def _acquire_token_silently(self, *scopes, **kwargs):
# type: (*str, **Any) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes, **kwargs)

def _request_token(self, *scopes, **kwargs):
# type: (*str, **Any) -> AccessToken
Expand Down
6 changes: 3 additions & 3 deletions sdk/identity/azure-identity/azure/identity/_credentials/service_fabric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ def get_token(self, *scopes, **kwargs):
)
return super(ServiceFabricCredential, self).get_token(*scopes, **kwargs)

def _acquire_token_silently(self, *scopes):
# type: (*str) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes)
def _acquire_token_silently(self, *scopes, **kwargs):
# type: (*str, **Any) -> Optional[AccessToken]
return self._client.get_cached_token(*scopes, **kwargs)

def _request_token(self, *scopes, **kwargs):
# type: (*str, **Any) -> AccessToken
Expand Down
2 changes: 1 addition & 1 deletion sdk/identity/azure-identity/azure/identity/_internal/client_credential_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def _request_token(self, *scopes, **kwargs):
# type: (*str, **Any) -> Optional[AccessToken]
app = self._get_app()
request_time = int(time.time())
result = app.acquire_token_for_client(list(scopes))
result = app.acquire_token_for_client(list(scopes), **kwargs)
if "access_token" not in result:
message = "Authentication failed: {}".format(result.get("error_description") or result.get("error"))
raise ClientAuthenticationError(message=message)
Expand Down
8 changes: 4 additions & 4 deletions sdk/identity/azure-identity/azure/identity/_internal/get_token_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ def __init__(self, *args, **kwargs):
super(GetTokenMixin, self).__init__(*args, **kwargs) # type: ignore

@abc.abstractmethod
def _acquire_token_silently(self, *scopes):
# type: (*str) -> Optional[AccessToken]
def _acquire_token_silently(self, *scopes, **kwargs):
# type: (*str, **Any) -> Optional[AccessToken]
"""Attempt to acquire an access token from a cache or by redeeming a refresh token"""

@abc.abstractmethod
Expand Down Expand Up @@ -66,10 +66,10 @@ def get_token(self, *scopes, **kwargs):
raise ValueError('"get_token" requires at least one scope')

try:
token = self._acquire_token_silently(*scopes)
token = self._acquire_token_silently(*scopes, **kwargs)
if not token:
self._last_request_time = int(time.time())
token = self._request_token(*scopes)
token = self._request_token(*scopes, **kwargs)
elif self._should_refresh(token):
try:
self._last_request_time = int(time.time())
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/azure/identity/_internal/managed_identity_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ def _process_response(self, response, request_time):

return token

def get_cached_token(self, *scopes):
# type: (*str) -> Optional[AccessToken]
def get_cached_token(self, *scopes, **kwargs): # pylint:disable=unused-argument
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is more complicated than the change itself:

  • Service Principal credentials support data, but
  • Managed Identity credentials don't. (They may support data in the future.)

Making them share the same GetTokenMixin adds unused kwargs to ManagedIdentityClientBase.get_cached_token.

# type: (*str, **Any) -> Optional[AccessToken]
resource = _scopes_to_resource(*scopes)
tokens = self._cache.find(TokenCache.CredentialType.ACCESS_TOKEN, target=[resource])
for token in tokens:
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/azure/identity/aio/_credentials/app_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ async def get_token( # pylint:disable=invalid-overridden-method
async def close(self) -> None:
await self._client.close() # pylint:disable=no-member

async def _acquire_token_silently(self, *scopes: str) -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes)
async def _acquire_token_silently(self, *scopes: str, **kwargs: "Any") -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes, **kwargs)

async def _request_token(self, *scopes: str, **kwargs: "Any") -> "AccessToken":
return await self._client.request_token(*scopes, **kwargs)
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/azure/identity/aio/_credentials/azure_arc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ async def get_token( # pylint:disable=invalid-overridden-method
async def close(self) -> None:
await self._client.close() # pylint:disable=no-member

async def _acquire_token_silently(self, *scopes: str) -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes)
async def _acquire_token_silently(self, *scopes: str, **kwargs: "Any") -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes, **kwargs)

async def _request_token(self, *scopes: str, **kwargs: "Any") -> "AccessToken":
return await self._client.request_token(*scopes, **kwargs)
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/azure/identity/aio/_credentials/cloud_shell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ async def get_token(self, *scopes: str, **kwargs: "Any") -> "AccessToken":
async def close(self) -> None:
await self._client.close()

async def _acquire_token_silently(self, *scopes: str) -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes)
async def _acquire_token_silently(self, *scopes: str, **kwargs: "Any") -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes, **kwargs)

async def _request_token(self, *scopes: str, **kwargs: "Any") -> "AccessToken":
return await self._client.request_token(*scopes, **kwargs)
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/azure/identity/aio/_credentials/service_fabric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ async def get_token( # pylint:disable=invalid-overridden-method
async def close(self) -> None:
await self._client.close() # pylint:disable=no-member

async def _acquire_token_silently(self, *scopes: str) -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes)
async def _acquire_token_silently(self, *scopes: str, **kwargs: "Any") -> "Optional[AccessToken]":
return self._client.get_cached_token(*scopes, **kwargs)

async def _request_token(self, *scopes: str, **kwargs: "Any") -> "AccessToken":
return await self._client.request_token(*scopes, **kwargs)
2 changes: 1 addition & 1 deletion sdk/identity/azure-identity/azure/identity/aio/_internal/get_token_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def __init__(self, *args: "Any", **kwargs: "Any") -> None:
super(GetTokenMixin, self).__init__(*args, **kwargs) # type: ignore

@abc.abstractmethod
async def _acquire_token_silently(self, *scopes: str) -> "Optional[AccessToken]":
async def _acquire_token_silently(self, *scopes: str, **kwargs: "Any") -> "Optional[AccessToken]":
"""Attempt to acquire an access token from a cache or by redeeming a refresh token"""

@abc.abstractmethod
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/tests/test_get_token_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ def __init__(self, cached_token=None):
self.request_token = mock.Mock(return_value=MockCredential.NEW_TOKEN)
self.acquire_token_silently = mock.Mock(return_value=cached_token)

def _acquire_token_silently(self, *scopes):
return self.acquire_token_silently(*scopes)
def _acquire_token_silently(self, *scopes, **kwargs):
return self.acquire_token_silently(*scopes, **kwargs)

def _request_token(self, *scopes, **kwargs):
return self.request_token(*scopes, **kwargs)
Expand Down
4 changes: 2 additions & 2 deletions sdk/identity/azure-identity/tests/test_get_token_mixin_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ def __init__(self, cached_token=None):
self.request_token = mock.Mock(return_value=MockCredential.NEW_TOKEN)
self.acquire_token_silently = mock.Mock(return_value=cached_token)

async def _acquire_token_silently(self, *scopes):
return self.acquire_token_silently(*scopes)
async def _acquire_token_silently(self, *scopes, **kwargs):
return self.acquire_token_silently(*scopes, **kwargs)

async def _request_token(self, *scopes, **kwargs):
return self.request_token(*scopes, **kwargs)
Expand Down