ADO Work Item Reference

AB#37905
AB#37927
AB#37926

Summary

This pull request introduces significant enhancements to themssql-python package, focusing on expanding authentication support and improving connection string handling. The most notable changes include adding support for new Azure Active Directory (AAD) authentication methods, implementing a dedicated authentication module, and integrating these updates into the connection handling logic.

Authentication Enhancements:

• Expanded AAD Authentication Methods: The documentation (README.md) now reflects support for additional authentication methods, includingActiveDirectoryInteractive (via browser),ActiveDirectoryDeviceCode (for environments without browser access), andActiveDirectoryDefault (which selects the best method based on the environment). Notes were added to clarify usage and constraints for these methods.

• Newauth.py Module: Introduced a dedicated module (mssql_python/auth.py) to handle AAD authentication. This module includes:

  • Support forDefaultAzureCredential,DeviceCodeCredential, andInteractiveBrowserCredential for token retrieval.
  • Utility functions for processing connection string parameters, removing sensitive data, and generating SQL Server-compatible token structures.

Connection Handling Updates:

• Integration of Authentication Logic: Theprocess_connection_string function from the newauth.py module was integrated into the connection initialization process inmssql_python/connection.py. If the connection string specifies an AAD authentication type, it is processed to remove sensitive parameters and include the appropriate authentication token inattrs_before.

• Import Update: Theprocess_connection_string function was imported intomssql_python/connection.py to enable the integration of the new authentication logic.