Skip to content

{Auth} Clarify Identity class's boundary #31014

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
jiasli merged 1 commit into from
Mar 17, 2025
Merged

{Auth} Clarify Identity class's boundary #31014

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 1 addition & 13 deletions src/azure-cli-core/azure/cli/core/auth/identity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,7 @@


class Identity: # pylint: disable=too-many-instance-attributes
"""Class to manage identities:
- user
- service principal
- TODO: managed identity
"""Manage user or service principal identities and log into Microsoft identity platform.
"""

# MSAL token cache.
Expand Down Expand Up @@ -199,12 +196,6 @@ def login_with_service_principal(self, client_id, credential, scopes):
entry = sp_auth.get_entry_to_persist()
self._service_principal_store.save_entry(entry)

def login_with_managed_identity(self, scopes, identity_id=None): # pylint: disable=too-many-statements
raise NotImplementedError

def login_in_cloud_shell(self, scopes):
raise NotImplementedError
Comment on lines -205 to -206
Copy link
Member

@evelyn-ys evelyn-ys Mar 17, 2025

Choose a reason for hiding this comment

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

Why do we need to remove login_in_cloud_shell Since cloud_shell is a special user identity in msal?

Copy link
Member Author

@jiasli jiasli Mar 17, 2025

Choose a reason for hiding this comment

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

I don't agree with MSAL's design, see #29637 (comment), #29637 (comment) for detailed explanations.

I want to keep the calling pattern for Identity consistent - authority should always be a required parameter.

For Cloud Shell authentication, the CLI command is az login --identity. It is a managed identity credential, no matter what token is returned. Including CloudShellCredential in Identity blurs its boundary.


def logout_user(self, username):
# If username is an SP client ID, it is ignored
accounts = self._msal_app.get_accounts(username)
Expand Down Expand Up @@ -251,9 +242,6 @@ def get_service_principal_credential(self, client_id):
client_credential = ServicePrincipalAuth(entry).get_msal_client_credential()
return ServicePrincipalCredential(client_id, client_credential, **self._msal_app_kwargs)

def get_managed_identity_credential(self, client_id=None):
raise NotImplementedError


class ServicePrincipalAuth: # pylint: disable=too-many-instance-attributes
def __init__(self, entry):
Expand Down