py2docfx 0.1.14.dev2019025__py3-none-any.whl → 0.1.15__py3-none-any.whl

py2docfx/venv/venv1/Lib/site-packages/adodbapi/test/adodbapitest.py

@@ -1,4 +1,4 @@
-""" Unit tests version 2.6.1.0 for adodbapi"""
+"""Unit tests version 2.6.1.0 for adodbapi"""
 
 """
     adodbapi - A python DB API 2.0 interface to Microsoft ADO
@@ -27,25 +27,15 @@ import datetime
 import decimal
 import random
 import string
-import sys
 import time
 import unittest
 
 import adodbapitestconfig as config  # run the configuration module. # will set sys.path to find correct version of adodbapi
 import tryconnection  # in our code below, all our switches are from config.whatever
-import win32com.client
 
 import adodbapi
 import adodbapi.apibase as api
 
-try:
-    import adodbapi.ado_consts as ado_consts
-except ImportError:  # we are doing a shortcut import as a module -- so
-    try:
-        import ado_consts
-    except ImportError:
-        from adodbapi import ado_consts
-
 
 def randomstring(length):
     return "".join([random.choice(string.ascii_letters) for n in range(32)])
@@ -189,49 +179,6 @@ class CommonDBTests(unittest.TestCase):
                 pass
             self.helpRollbackTblTemp()
 
-    def testUserDefinedConversionForExactNumericTypes(self):
-        # variantConversions is a dictionary of conversion functions
-        # held internally in adodbapi.apibase
-        #
-        # !!! this test intentionally alters the value of what should be constant in the module
-        # !!! no new code should use this example, to is only a test to see that the
-        # !!! deprecated way of doing this still works.  (use connection.variantConversions)
-        #
-        if sys.version_info < (3, 0):  ### Py3 need different test
-            oldconverter = adodbapi.variantConversions[
-                ado_consts.adNumeric
-            ]  # keep old function to restore later
-            # By default decimal and "numbers" are returned as decimals.
-            # Instead, make numbers return as  floats
-            try:
-                adodbapi.variantConversions[ado_consts.adNumeric] = adodbapi.cvtFloat
-                self.helpTestDataType(
-                    "decimal(18,2)", "NUMBER", 3.45, compareAlmostEqual=1
-                )
-                self.helpTestDataType(
-                    "numeric(18,2)", "NUMBER", 3.45, compareAlmostEqual=1
-                )
-                # now return strings
-                adodbapi.variantConversions[ado_consts.adNumeric] = adodbapi.cvtString
-                self.helpTestDataType("numeric(18,2)", "NUMBER", "3.45")
-                # now a completly weird user defined convertion
-                adodbapi.variantConversions[ado_consts.adNumeric] = (
-                    lambda x: "!!This function returns a funny unicode string %s!!" % x
-                )
-                self.helpTestDataType(
-                    "numeric(18,2)",
-                    "NUMBER",
-                    "3.45",
-                    allowedReturnValues=[
-                        "!!This function returns a funny unicode string 3.45!!"
-                    ],
-                )
-            finally:
-                # now reset the converter to its original function
-                adodbapi.variantConversions[ado_consts.adNumeric] = (
-                    oldconverter  # Restore the original convertion function
-                )
-
     def helpTestDataType(
         self,
         sqlDataTypeString,
@@ -326,15 +273,16 @@ class CommonDBTests(unittest.TestCase):
             rs = crsr.fetchone()
             if allowedReturnValues:
                 allowedTypes = tuple([type(aRV) for aRV in allowedReturnValues])
-                assert isinstance(
-                    rs[0], allowedTypes
-                ), 'result type "%s" must be one of %s' % (type(rs[0]), allowedTypes)
+                assert isinstance(rs[0], allowedTypes), (
+                    'result type "%s" must be one of %s' % (type(rs[0]), allowedTypes)
+                )
             else:
-                assert isinstance(
-                    rs[0], type(pyData)
-                ), 'result type "%s" must be instance of %s' % (
-                    type(rs[0]),
-                    type(pyData),
+                assert isinstance(rs[0], type(pyData)), (
+                    'result type "%s" must be instance of %s'
+                    % (
+                        type(rs[0]),
+                        type(pyData),
+                    )
                 )
 
             if compareAlmostEqual and DBAPIDataTypeString == "DATETIME":
@@ -344,9 +292,9 @@ class CommonDBTests(unittest.TestCase):
             elif compareAlmostEqual:
                 s = float(pyData)
                 v = float(rs[0])
-                assert (
-                    abs(v - s) / s < 0.00001
-                ), "Values not almost equal recvd=%s, expected=%f" % (rs[0], s)
+                assert abs(v - s) / s < 0.00001, (
+                    "Values not almost equal recvd=%s, expected=%f" % (rs[0], s)
+                )
             else:
                 if allowedReturnValues:
                     ok = False
@@ -432,7 +380,7 @@ class CommonDBTests(unittest.TestCase):
                 "bigint",
                 "NUMBER",
                 3000000000,
-                allowedReturnValues=[3000000000, int(3000000000)],
+                allowedReturnValues=[3000000000, 3000000000],
             )
         self.helpTestDataType("int", "NUMBER", 2147483647)
 
@@ -488,7 +436,7 @@ class CommonDBTests(unittest.TestCase):
             )
 
     def testDataTypeBinary(self):
-        binfld = b"\x07\x00\xE2\x40*"
+        binfld = b"\x07\x00\xe2\x40*"
         arv = [binfld, adodbapi.Binary(binfld), bytes(binfld)]
         if self.getEngine() == "PostgreSQL":
             self.helpTestDataType(
@@ -693,9 +641,9 @@ class CommonDBTests(unittest.TestCase):
             rec = crsr.fetchone()
             # check that stepping through an emulated row works
             for j in range(len(inParam)):
-                assert (
-                    rec[j] == inParam[j]
-                ), 'returned value:"%s" != test value:"%s"' % (rec[j], inParam[j])
+                assert rec[j] == inParam[j], (
+                    'returned value:"%s" != test value:"%s"' % (rec[j], inParam[j])
+                )
             # check that we can get a complete tuple from a row
             assert (
                 tuple(rec) == inParam
@@ -1136,7 +1084,7 @@ class TestADOwithSQLServer(CommonDBTests):
         return self.conn
 
     def getAnotherConnection(self, addkeys=None):
-        keys = dict(config.connStrSQLServer[1])
+        keys = config.connStrSQLServer[1].copy()
         if addkeys:
             keys.update(addkeys)
         return config.dbSqlServerconnect(*config.connStrSQLServer[0], **keys)
@@ -1316,7 +1264,7 @@ class TestADOwithMySql(CommonDBTests):
         return self.conn
 
     def getAnotherConnection(self, addkeys=None):
-        keys = dict(config.connStrMySql[1])
+        keys = config.connStrMySql[1].copy()
         if addkeys:
             keys.update(addkeys)
         return config.dbMySqlconnect(*config.connStrMySql[0], **keys)
@@ -1382,7 +1330,7 @@ class TestADOwithPostgres(CommonDBTests):
         return self.conn
 
     def getAnotherConnection(self, addkeys=None):
-        keys = dict(config.connStrPostgres[1])
+        keys = config.connStrPostgres[1].copy()
         if addkeys:
             keys.update(addkeys)
         return config.dbPostgresConnect(*config.connStrPostgres[0], **keys)

py2docfx/venv/venv1/Lib/site-packages/adodbapi/test/adodbapitestconfig.py

@@ -166,7 +166,7 @@ if doPostgresTest:
         "Provider=MSDASQL;Driver={PostgreSQL Unicode(x64)}",
         "Driver=PostgreSQL Unicode",
     ]
-    # get driver from http://www.postgresql.org/ftp/odbc/versions/
+    # get driver from https://www.postgresql.org/ftp/odbc/releases/
     # test using positional and keyword arguments (bad example for real code)
     print("    ...Testing PostgreSQL login to {}...".format(_computername))
     doPostgresTest, connStrPostgres, dbPostgresConnect = tryconnection.try_connection(

py2docfx/venv/venv1/Lib/site-packages/adodbapi/test/dbapi20.py

@@ -1,20 +1,19 @@
 #!/usr/bin/env python
-""" Python DB API 2.0 driver compliance unit test suite.
+"""Python DB API 2.0 driver compliance unit test suite.
 
-    This software is Public Domain and may be used without restrictions.
+   This software is Public Domain and may be used without restrictions.
 
- "Now we have booze and barflies entering the discussion, plus rumours of
-  DBAs on drugs... and I won't tell you what flashes through my mind each
-  time I read the subject line with 'Anal Compliance' in it.  All around
-  this is turning out to be a thoroughly unwholesome unit test."
+"Now we have booze and barflies entering the discussion, plus rumours of
+ DBAs on drugs... and I won't tell you what flashes through my mind each
+ time I read the subject line with 'Anal Compliance' in it.  All around
+ this is turning out to be a thoroughly unwholesome unit test."
 
-    -- Ian Bicking
+   -- Ian Bicking
 """
 
 __version__ = "$Revision: 1.15.0 $"[11:-2]
 __author__ = "Stuart Bishop <stuart@stuartbishop.net>"
 
-import sys
 import time
 import unittest
 
@@ -71,7 +70,7 @@ TEST_FOR_NON_IDEMPOTENT_CLOSE = False
 # - Now a subclass of TestCase, to avoid requiring the driver stub
 #   to use multiple inheritance
 # - Reversed the polarity of buggy test in test_description
-# - Test exception heirarchy correctly
+# - Test exception hierarchy correctly
 # - self.populate is now self._populate(), so if a driver stub
 #   overrides self.ddl1 this change propogates
 # - VARCHAR columns now have a width, which will hopefully make the
@@ -197,14 +196,9 @@ class DatabaseAPI20Test(unittest.TestCase):
             self.fail("Driver doesn't define paramstyle")
 
     def test_Exceptions(self):
-        # Make sure required exceptions exist, and are in the
-        # defined heirarchy.
-        if sys.version[0] == "3":  # under Python 3 StardardError no longer exists
-            self.assertTrue(issubclass(self.driver.Warning, Exception))
-            self.assertTrue(issubclass(self.driver.Error, Exception))
-        else:
-            self.failUnless(issubclass(self.driver.Warning, Exception))
-            self.failUnless(issubclass(self.driver.Error, Exception))
+        # Make sure required exceptions exist, and are in the defined hierarchy.
+        self.assertTrue(issubclass(self.driver.Warning, Exception))
+        self.assertTrue(issubclass(self.driver.Error, Exception))
 
         self.assertTrue(issubclass(self.driver.InterfaceError, self.driver.Error))
         self.assertTrue(issubclass(self.driver.DatabaseError, self.driver.Error))

py2docfx/venv/venv1/Lib/site-packages/adodbapi/test/setuptestframework.py

@@ -1,6 +1,7 @@
 #!/usr/bin/python2
 # Configure this in order to run the testcases.
 "setuptestframework.py v 2.6.0.8"
+
 import os
 import shutil
 import tempfile
@@ -55,7 +56,7 @@ def makeadopackage(testfolder):
                 shutil.copy(os.path.join(adoPath, f), newpackage)
         return testfolder
     else:
-        raise OSError("Connot find source of adodbapi to test.")
+        raise OSError("Cannot find source of adodbapi to test.")
 
 
 def makemdb(testfolder, mdb_name):

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/application.py

@@ -104,7 +104,7 @@ class AzureApplicationCredential(ChainedTokenCredential):
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The exception has a
             `message` attribute listing each authentication attempt and its error message.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/authorization_code.py

@@ -105,7 +105,7 @@ class AuthorizationCodeCredential(GetTokenMixin):
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
           attribute gives a reason. Any error response from Microsoft Entra ID is available as the error's

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/azd_cli.py

@@ -142,7 +142,7 @@ class AzureDeveloperCliCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
 
         :raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/azure_cli.py

@@ -133,7 +133,7 @@ class AzureCliCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
 
         :raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke the Azure CLI.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/azure_pipelines.py

@@ -141,7 +141,7 @@ class AzurePipelinesCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
             attribute gives a reason.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/azure_powershell.py

@@ -146,7 +146,7 @@ class AzurePowerShellCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
 
         :raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke Azure PowerShell, or

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/chained.py

@@ -166,7 +166,7 @@ class ChainedTokenCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
 
         :raises ~azure.core.exceptions.ClientAuthenticationError: no credential in the chain provided a token.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/default.py

@@ -239,7 +239,7 @@ class DefaultAzureCredential(ChainedTokenCredential):
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
 
         :raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The exception has a

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/environment.py

@@ -46,6 +46,9 @@ class EnvironmentCredential:
         when no value is given.
 
     User with username and password:
+      **Deprecated**: Username and password authentication doesn't support multifactor authentication (MFA).
+      For more details on Microsoft Entra MFA enforcement, see https://aka.ms/azsdk/identity/mfa.
+
       - **AZURE_CLIENT_ID**: the application's client ID
       - **AZURE_USERNAME**: a username (usually an email address)
       - **AZURE_PASSWORD**: that user's password
@@ -168,7 +171,7 @@ class EnvironmentCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
 
         :raises ~azure.identity.CredentialUnavailableError: environment variable configuration is incomplete.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/managed_identity.py

@@ -4,7 +4,7 @@
 # ------------------------------------
 import logging
 import os
-from typing import Optional, Any, Mapping, cast
+from typing import Optional, Any, Mapping, cast, Tuple
 
 from azure.core.credentials import AccessToken, AccessTokenInfo, TokenRequestOptions, TokenCredential, SupportsTokenInfo
 from .. import CredentialUnavailableError
@@ -15,20 +15,34 @@ from .._internal.decorators import log_get_token
 _LOGGER = logging.getLogger(__name__)
 
 
-def validate_identity_config(client_id: Optional[str], identity_config: Optional[Mapping[str, str]]) -> None:
+def validate_identity_config(
+    client_id: Optional[str], identity_config: Optional[Mapping[str, str]]
+) -> Optional[Tuple[str, str]]:
     if identity_config:
+        valid_keys = {"object_id", "resource_id", "client_id"}
         if client_id:
-            if any(key in identity_config for key in ("object_id", "resource_id", "client_id")):
+            if any(key in identity_config for key in valid_keys):
                 raise ValueError(
-                    "identity_config must not contain 'object_id', 'resource_id', or 'client_id' when 'client_id' is "
-                    "provided as a keyword argument."
+                    "When 'client_id' is provided as a keyword argument, 'identity_config' must not contain any of the "
+                    f"following keys: {', '.join(valid_keys)}"
                 )
-        # Only one of these keys should be present if one is present.
-        valid_keys = {"object_id", "resource_id", "client_id"}
-        if len(identity_config.keys() & valid_keys) > 1:
-            raise ValueError(
-                f"identity_config must not contain more than one of the following keys: {', '.join(valid_keys)}"
-            )
+            return "client_id", client_id
+
+        # Only one of the valid keys should be present if one is present.
+        result = None
+        for key in valid_keys:
+            if key in identity_config:
+                if result:
+                    raise ValueError(
+                        "identity_config must not contain more than one of the following keys: "
+                        f"{', '.join(valid_keys)}"
+                    )
+                result = key, identity_config[key]
+        return result
+
+    if client_id:
+        return "client_id", client_id
+    return None
 
 
 class ManagedIdentityCredential:
@@ -59,38 +73,40 @@ class ManagedIdentityCredential:
     def __init__(
         self, *, client_id: Optional[str] = None, identity_config: Optional[Mapping[str, str]] = None, **kwargs: Any
     ) -> None:
-        validate_identity_config(client_id, identity_config)
+        user_identity_info = validate_identity_config(client_id, identity_config)
         self._credential: Optional[SupportsTokenInfo] = None
         exclude_workload_identity = kwargs.pop("_exclude_workload_identity_credential", False)
+        managed_identity_type = None
+
         if os.environ.get(EnvironmentVariables.IDENTITY_ENDPOINT):
             if os.environ.get(EnvironmentVariables.IDENTITY_HEADER):
                 if os.environ.get(EnvironmentVariables.IDENTITY_SERVER_THUMBPRINT):
-                    _LOGGER.info("%s will use Service Fabric managed identity", self.__class__.__name__)
+                    managed_identity_type = "Service Fabric managed identity"
                     from .service_fabric import ServiceFabricCredential
 
                     self._credential = ServiceFabricCredential(
                         client_id=client_id, identity_config=identity_config, **kwargs
                     )
                 else:
-                    _LOGGER.info("%s will use App Service managed identity", self.__class__.__name__)
+                    managed_identity_type = "App Service managed identity"
                     from .app_service import AppServiceCredential
 
                     self._credential = AppServiceCredential(
                         client_id=client_id, identity_config=identity_config, **kwargs
                     )
             elif os.environ.get(EnvironmentVariables.IMDS_ENDPOINT):
-                _LOGGER.info("%s will use Azure Arc managed identity", self.__class__.__name__)
+                managed_identity_type = "Azure Arc managed identity"
                 from .azure_arc import AzureArcCredential
 
                 self._credential = AzureArcCredential(client_id=client_id, identity_config=identity_config, **kwargs)
         elif os.environ.get(EnvironmentVariables.MSI_ENDPOINT):
             if os.environ.get(EnvironmentVariables.MSI_SECRET):
-                _LOGGER.info("%s will use Azure ML managed identity", self.__class__.__name__)
+                managed_identity_type = "Azure ML managed identity"
                 from .azure_ml import AzureMLCredential
 
                 self._credential = AzureMLCredential(client_id=client_id, identity_config=identity_config, **kwargs)
             else:
-                _LOGGER.info("%s will use Cloud Shell managed identity", self.__class__.__name__)
+                managed_identity_type = "Cloud Shell managed identity"
                 from .cloud_shell import CloudShellCredential
 
                 self._credential = CloudShellCredential(client_id=client_id, identity_config=identity_config, **kwargs)
@@ -98,12 +114,17 @@ class ManagedIdentityCredential:
             all(os.environ.get(var) for var in EnvironmentVariables.WORKLOAD_IDENTITY_VARS)
             and not exclude_workload_identity
         ):
-            _LOGGER.info("%s will use workload identity", self.__class__.__name__)
             from .workload_identity import WorkloadIdentityCredential
 
             workload_client_id = client_id or os.environ.get(EnvironmentVariables.AZURE_CLIENT_ID)
             if not workload_client_id:
-                raise ValueError('Configure the environment with a client ID or pass a value for "client_id" argument')
+                raise ValueError(
+                    "Workload identity was selected but no client ID was provided. "
+                    'Configure the environment with a client ID or pass a value for "client_id" argument'
+                )
+
+            managed_identity_type = "workload identity"
+            user_identity_info = ("client_id", workload_client_id)
 
             self._credential = WorkloadIdentityCredential(
                 tenant_id=os.environ[EnvironmentVariables.AZURE_TENANT_ID],
@@ -112,11 +133,17 @@ class ManagedIdentityCredential:
                 **kwargs,
             )
         else:
+            managed_identity_type = "IMDS"
             from .imds import ImdsCredential
 
-            _LOGGER.info("%s will use IMDS", self.__class__.__name__)
             self._credential = ImdsCredential(client_id=client_id, identity_config=identity_config, **kwargs)
 
+        if managed_identity_type:
+            log_msg = f"{self.__class__.__name__} will use {managed_identity_type}"
+            if user_identity_info:
+                log_msg += f" with {user_identity_info[0]}: {user_identity_info[1]}"
+            _LOGGER.info(log_msg)
+
     def __enter__(self) -> "ManagedIdentityCredential":
         if self._credential:
             self._credential.__enter__()  # type: ignore
@@ -171,7 +198,7 @@ class ManagedIdentityCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises ~azure.identity.CredentialUnavailableError: managed identity isn't available in the hosting environment.
         """

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/shared_cache.py

@@ -100,7 +100,7 @@ class SharedTokenCacheCredential:
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises ~azure.identity.CredentialUnavailableError: the cache is unavailable or contains insufficient user
             information.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/user_password.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License.
 # ------------------------------------
 from typing import Any, Dict
+import warnings
 
 from .._internal import InteractiveCredential, wrap_exceptions
 
@@ -10,6 +11,9 @@ from .._internal import InteractiveCredential, wrap_exceptions
 class UsernamePasswordCredential(InteractiveCredential):
     """Authenticates a user with a username and password.
 
+    **Deprecated**: This credential doesn't support multifactor authentication (MFA).
+    For more details on Microsoft Entra MFA enforcement, see https://aka.ms/azsdk/identity/mfa.
+
     In general, Microsoft doesn't recommend this kind of authentication, because it's less secure than other
     authentication flows.
 
@@ -59,6 +63,12 @@ class UsernamePasswordCredential(InteractiveCredential):
     """
 
     def __init__(self, client_id: str, username: str, password: str, **kwargs: Any) -> None:
+        warnings.warn(
+            f"{self.__class__.__name__} is deprecated, as is it doesn't support multifactor "
+            "authentication (MFA). For more details, see https://aka.ms/azsdk/identity/mfa.",
+            category=DeprecationWarning,
+            stacklevel=2,
+        )
         # The base class will accept an AuthenticationRecord, allowing this credential to authenticate silently the
         # first time it's asked for a token. However, we want to ensure this first authentication is not silent, to
         # validate the given password. This class therefore doesn't document the authentication_record argument, and we

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/vscode.py

@@ -183,7 +183,7 @@ class VisualStudioCodeCredential(_VSCodeCredentialBase, GetTokenMixin):
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises ~azure.identity.CredentialUnavailableError: the credential cannot retrieve user details from Visual
           Studio Code.

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_internal/aad_client_base.py

@@ -61,6 +61,7 @@ class AadClientBase(abc.ABC):
             self._custom_cache = True
         else:
             self._custom_cache = False
+        self._is_adfs = self._tenant_id.lower() == "adfs"
 
     def _get_cache(self, **kwargs: Any) -> TokenCache:
         cache = self._cae_cache if kwargs.get("enable_cae") else self._cache
@@ -239,7 +240,16 @@ class AadClientBase(abc.ABC):
 
     def _get_client_certificate_assertion(self, certificate: AadClientCertificate, **kwargs: Any) -> str:
         now = int(time.time())
-        header = json.dumps({"typ": "JWT", "alg": "RS256", "x5t": certificate.thumbprint}).encode("utf-8")
+        headers = {"typ": "JWT"}
+        if self._is_adfs:
+            # Maintain backwards compatibility with older versions of ADFS.
+            headers["alg"] = "RS256"
+            headers["x5t"] = certificate.thumbprint
+        else:
+            headers["alg"] = "PS256"
+            headers["x5t#S256"] = certificate.sha256_thumbprint
+
+        jwt_header = json.dumps(headers).encode("utf-8")
         payload = json.dumps(
             {
                 "jti": str(uuid4()),
@@ -250,8 +260,8 @@ class AadClientBase(abc.ABC):
                 "exp": now + (60 * 30),
             }
         ).encode("utf-8")
-        jws = base64.urlsafe_b64encode(header) + b"." + base64.urlsafe_b64encode(payload)
-        signature = certificate.sign(jws)
+        jws = base64.urlsafe_b64encode(jwt_header) + b"." + base64.urlsafe_b64encode(payload)
+        signature = certificate.sign_ps256(jws) if not self._is_adfs else certificate.sign_rs256(jws)
         jwt_bytes = jws + b"." + base64.urlsafe_b64encode(signature)
         return jwt_bytes.decode("utf-8")
 

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_internal/aadclient_certificate.py

@@ -26,7 +26,9 @@ class AadClientCertificate:
 
         cert = x509.load_pem_x509_certificate(pem_bytes, default_backend())
         fingerprint = cert.fingerprint(hashes.SHA1())  # nosec
+        sha256_fingerprint = cert.fingerprint(hashes.SHA256())
         self._thumbprint = base64.urlsafe_b64encode(fingerprint).decode("utf-8")
+        self._sha256_thumbprint = base64.urlsafe_b64encode(sha256_fingerprint).decode("utf-8")
 
     @property
     def thumbprint(self) -> str:
@@ -36,7 +38,15 @@ class AadClientCertificate:
         """
         return self._thumbprint
 
-    def sign(self, plaintext: bytes) -> bytes:
+    @property
+    def sha256_thumbprint(self) -> str:
+        """The certificate's SHA256 thumbprint as a base64url-encoded string.
+
+        :rtype: str
+        """
+        return self._sha256_thumbprint
+
+    def sign_rs256(self, plaintext: bytes) -> bytes:
         """Sign bytes using RS256.
 
         :param bytes plaintext: Bytes to sign.
@@ -44,3 +54,20 @@ class AadClientCertificate:
         :rtype: bytes
         """
         return self._private_key.sign(plaintext, padding.PKCS1v15(), hashes.SHA256())
+
+    def sign_ps256(self, plaintext: bytes) -> bytes:
+        """Sign bytes using PS256.
+
+        :param bytes plaintext: Bytes to sign.
+        :return: The signature.
+        :rtype: bytes
+        """
+        hash_alg = hashes.SHA256()
+
+        # Note: For PS265, the salt length should match the hash output size, so we use the hash algorithm's
+        # digest_size property to get the correct value.
+        return self._private_key.sign(
+            plaintext,
+            padding.PSS(mgf=padding.MGF1(hash_alg), salt_length=hash_alg.digest_size),
+            hash_alg,
+        )

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_version.py

@@ -2,4 +2,4 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-VERSION = "1.20.0"
+VERSION = "1.21.0"