Source code for azure.core.credentials

# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE.txt in the project root for
# license information.
# -------------------------------------------------------------------------
from collections import namedtuple
from typing import Any, NamedTuple, Optional
from typing_extensions import Protocol
import six


[docs]class AccessToken(NamedTuple): """Represents an OAuth access token.""" token: str expires_on: int
AccessToken.token.__doc__ = """The token string.""" AccessToken.expires_on.__doc__ = """The token's expiration time in Unix time."""
[docs]class TokenCredential(Protocol): """Protocol for classes able to provide OAuth tokens."""
[docs] def get_token( self, *scopes: str, claims: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs: Any ) -> AccessToken: """Request an access token for `scopes`. :param str scopes: The type of access needed. :keyword str claims: Additional claims required in the token, such as those returned in a resource provider's claims challenge following an authorization failure. :keyword str tenant_id: Optional tenant to include in the token request. :rtype: AccessToken :return: An AccessToken instance containing the token string and its expiration time in Unix time. """
AzureNamedKey = namedtuple("AzureNamedKey", ["name", "key"]) __all__ = ["AzureKeyCredential", "AzureSasCredential", "AccessToken", "AzureNamedKeyCredential", "TokenCredential"]
[docs]class AzureKeyCredential(object): """Credential type used for authenticating to an Azure service. It provides the ability to update the key without creating a new client. :param str key: The key used to authenticate to an Azure service :raises: TypeError """ def __init__(self, key): # type: (str) -> None if not isinstance(key, six.string_types): raise TypeError("key must be a string.") self._key = key # type: str @property def key(self): # type () -> str """The value of the configured key. :rtype: str """ return self._key
[docs] def update(self, key): # type: (str) -> None """Update the key. This can be used when you've regenerated your service key and want to update long-lived clients. :param str key: The key used to authenticate to an Azure service :raises: ValueError or TypeError """ if not key: raise ValueError("The key used for updating can not be None or empty") if not isinstance(key, six.string_types): raise TypeError("The key used for updating must be a string.") self._key = key
[docs]class AzureSasCredential(object): """Credential type used for authenticating to an Azure service. It provides the ability to update the shared access signature without creating a new client. :param str signature: The shared access signature used to authenticate to an Azure service :raises: TypeError """ def __init__(self, signature): # type: (str) -> None if not isinstance(signature, six.string_types): raise TypeError("signature must be a string.") self._signature = signature # type: str @property def signature(self): # type () -> str """The value of the configured shared access signature. :rtype: str """ return self._signature
[docs] def update(self, signature): # type: (str) -> None """Update the shared access signature. This can be used when you've regenerated your shared access signature and want to update long-lived clients. :param str signature: The shared access signature used to authenticate to an Azure service :raises: ValueError or TypeError """ if not signature: raise ValueError("The signature used for updating can not be None or empty") if not isinstance(signature, six.string_types): raise TypeError("The signature used for updating must be a string.") self._signature = signature
[docs]class AzureNamedKeyCredential(object): """Credential type used for working with any service needing a named key that follows patterns established by the other credential types. :param str name: The name of the credential used to authenticate to an Azure service. :param str key: The key used to authenticate to an Azure service. :raises: TypeError """ def __init__(self, name, key): # type: (str, str) -> None if not isinstance(name, six.string_types) or not isinstance(key, six.string_types): raise TypeError("Both name and key must be strings.") self._credential = AzureNamedKey(name, key) @property def named_key(self): # type () -> AzureNamedKey """The value of the configured name. :rtype: AzureNamedKey """ return self._credential
[docs] def update(self, name, key): # type: (str, str) -> None """Update the named key credential. Both name and key must be provided in order to update the named key credential. Individual attributes cannot be updated. :param str name: The name of the credential used to authenticate to an Azure service. :param str key: The key used to authenticate to an Azure service. """ if not isinstance(name, six.string_types) or not isinstance(key, six.string_types): raise TypeError("Both name and key must be strings.") self._credential = AzureNamedKey(name, key)