forked from dotnet/SqlClient
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into Task-28274-Update-API-Documentation
- Loading branch information
Showing
11 changed files
with
175 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Release Notes | ||
|
|
||
| ## Microsoft.Data.SqlClient 5.1.5 released 29 January 2024 | ||
|
|
||
| This update includes the following changes over the previous release: | ||
|
|
||
| ### Fixed | ||
|
|
||
| - Fixed connection to unsubscribe from transaction completion events before returning it to the connection pool [#2321](https://github.com/dotnet/SqlClient/pull/2321) | ||
| - Fixed InvalidCastException when reading an Always Encrypted date or time column [#2324](https://github.com/dotnet/SqlClient/pull/2324) | ||
|
|
||
| ### Changed | ||
|
|
||
| - Changed Microsoft.IdentityModel.JsonWebTokens and Microsoft.IdentityModel.Protocols.OpenIdConnect version 6.24.0 to 6.35.0 [#2320](https://github.com/dotnet/SqlClient/pull/2320) to address [CVE-2024-21319](https://www.cve.org/CVERecord?id=CVE-2024-21319) | ||
|
|
||
| ## Target Platform Support | ||
|
|
||
| - .NET Framework 4.6.2+ (Windows x86, Windows x64) | ||
| - .NET 6.0+ (Windows x86, Windows x64, Windows ARM64, Windows ARM, Linux, macOS) | ||
| - .NET Standard 2.0+ (Windows x86, Windows x64, Windows ARM64, Windows ARM, Linux, macOS) | ||
|
|
||
| ### Dependencies | ||
|
|
||
| #### .NET Framework | ||
|
|
||
| - Microsoft.Data.SqlClient.SNI 5.1.1 | ||
| - Azure.Identity 1.10.3 | ||
| - Microsoft.Identity.Client 4.56.2 | ||
| - Microsoft.IdentityModel.JsonWebTokens 6.35.0 | ||
| - Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 | ||
| - System.Buffers 4.5.1 | ||
| - System.Configuration.ConfigurationManager 6.0.1 | ||
| - System.Runtime.InteropServices.RuntimeInformation 4.3.0 | ||
| - System.Text.Encoding.Web 6.0.0 | ||
|
|
||
| #### .NET | ||
|
|
||
| - Microsoft.Data.SqlClient.SNI 5.1.1 | ||
| - Azure.Identity 1.10.3 | ||
| - Microsoft.Identity.Client 4.56.2 | ||
| - Microsoft.IdentityModel.JsonWebTokens 6.35.0 | ||
| - Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 | ||
| - Microsoft.SqlServer.Server 1.0.0 | ||
| - System.Configuration.ConfigurationManager 6.0.1 | ||
| - System.Diagnostics.DiagnosticSource 6.0.0 | ||
| - System.Runtime.Caching 6.0.0 | ||
| - System.Text.Encoding.CodePages 6.0.0 | ||
| - System.Text.Encodings.Web 6.0.0 | ||
| - System.Security.Cryptography.Cng 5.0.0 | ||
| - System.Security.Principal.Windows 5.0.0 | ||
|
|
||
| #### .NET Standard | ||
|
|
||
| - Microsoft.Data.SqlClient.SNI 5.1.1 | ||
| - Azure.Identity 1.10.3 | ||
| - Microsoft.Identity.Client 4.56.2 | ||
| - Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 | ||
| - Microsoft.IdentityModel.JsonWebTokens 6.35.0 | ||
| - Microsoft.SqlServer.Server 1.0.0 | ||
| - Microsoft.Win32.Registry 5.0.0 | ||
| - System.Buffers 4.5.1 | ||
| - System.Configuration.ConfigurationManager 6.0.1 | ||
| - System.Runtime.Caching 6.0.0 | ||
| - System.Text.Encoding.CodePages 6.0.0 | ||
| - System.Text.Encodings.Web 6.0.0 | ||
| - System.Runtime.Loader 4.3.0 | ||
| - System.Security.Cryptography.Cng 5.0.0 | ||
| - System.Security.Principal.Windows 5.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # Release Notes | ||
|
|
||
| ## General Availability of Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider | ||
|
|
||
| _**5.1.0 released 01 February 2024**_ | ||
|
|
||
| This library contains the implementation of `Microsoft.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider` for accessing Azure Key Vault, and the provider class is named `SqlColumnEncryptionAzureKeyVaultProvider`. | ||
|
|
||
| ### Changed | ||
|
|
||
| - Changed Microsoft.Data.SqlClient version 3.0.0 to 5.1.5 [#2330](https://github.com/dotnet/SqlClient/pull/2330) | ||
| - Changed Azure.Core version 1.6.0 to 1.35.0 [#2330](https://github.com/dotnet/SqlClient/pull/2330) | ||
| - Changed Azure.Security.KeyVault.Keys 4.0.3 to 4.5.0 [#2330](https://github.com/dotnet/SqlClient/pull/2330) | ||
| - Changed Microsoft.Extensions.Caching.Memory 5.0.0 to 8.0.0 for .Net 8.0 and 6.0.1 for other Target frameworks [#2330](https://github.com/dotnet/SqlClient/pull/2330) | ||
|
|
||
| ### Working with SQLColumnEncryptionAzureKeyVaultProvider | ||
|
|
||
| `SqlColumnEncryptionAzureKeyVaultProvider` **v5.1** is implemented against `Microsoft.Data.SqlClient` **v5.1** and supports .NET Framework 4.6.2+, .NET Core 6.0+, and .NET Standard 2.0+. The provider name identifier for this library is "**AZURE_KEY_VAULT**" and it is not registered in the driver by default. Client applications may initialize this provider by providing an `Azure.Core.TokenCredential` and registering it with the driver using any of the below APIs: | ||
|
|
||
| - [SqlConnection.RegisterColumnEncryptionKeyStoreProviders](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnection.registercolumnencryptionkeystoreproviders?view=sqlclient-dotnet-5.1) | ||
| - [SqlConnection.RegisterColumnEncryptionKeyStoreProvidersOnConnection](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnection.registercolumnencryptionkeystoreprovidersonconnection?view=sqlclient-dotnet-5.1) (Added in version 3.0.0) | ||
| - [SqlCommand.RegisterColumnEncryptionKeyStoreProvidersOnCommand](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlcommand.registercolumnencryptionkeystoreprovidersoncommand?view=sqlclient-dotnet-5.1) (Added in version 3.0.0) | ||
|
|
||
| Once the provider is registered, it can be used to perform Always Encrypted operations by creating a Column Master Key using the Azure Key Vault Key Identifier URL. | ||
|
|
||
| The linked C# samples below demonstrate using Always Encrypted with secure enclaves with Azure Key Vault: | ||
|
|
||
| - Legacy API support (Always Encrypted): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/AzureKeyVaultProviderLegacyExample_2_0.cs) | ||
| - New API support (Always Encrypted): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/AzureKeyVaultProviderExample_2_0.cs) | ||
| - Legacy API support (Always Encrypted with secure enclaves): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/doc\samples\AzureKeyVaultProviderWithEnclaveProviderExample.cs) | ||
| - New API support (Always Encrypted with secure enclaves): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/doc\samples\AzureKeyVaultProviderWithEnclaveProviderExample_2_0.cs) | ||
| - Column Encryption Key cache scope example: [AzureKeyVaultProvider_ColumnEncryptionKeyCacheScope.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/AzureKeyVaultProvider_ColumnEncryptionKeyCacheScope.cs) | ||
| - Registering custom key store provider - Connection Precedence: [RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs) | ||
| - Registering custom key store provider - Command Precedence: [RegisterCustomKeyStoreProvider_CommandPrecedence.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/RegisterCustomKeyStoreProvider_CommandPrecedence.cs) | ||
|
|
||
| For further details, refer to [Using the Azure Key Vault provider](https://docs.microsoft.com/sql/connect/ado-net/sql/sqlclient-support-always-encrypted#using-the-azure-key-vault-provider) | ||
|
|
||
| ## Target Platform Support | ||
|
|
||
| - .NET Framework 4.6.2+ | ||
| - .NET Core 6.0+ (Windows x86, Windows x64, Linux, macOS) | ||
| - .NET Standard 2.0+ | ||
|
|
||
| ### Dependencies | ||
|
|
||
| #### .NET Framework | ||
|
|
||
| - Azure.Core 1.35.0 | ||
| - Azure.Security.KeyVault.Keys 4.5.0 | ||
| - Microsoft.Data.SqlClient 5.1.5 | ||
| - Microsoft.Extensions.Caching.Memory 6.0.1 | ||
|
|
||
| ##### .NET 6 | ||
|
|
||
| - Azure.Core 1.35.0 | ||
| - Azure.Security.KeyVault.Keys 4.5.0 | ||
| - Microsoft.Data.SqlClient 5.1.5 | ||
| - Microsoft.Extensions.Caching.Memory 6.0.1 | ||
|
|
||
| #### .NET 8 | ||
|
|
||
| - Azure.Core 1.35.0 | ||
| - Azure.Security.KeyVault.Keys 4.5.0 | ||
| - Microsoft.Data.SqlClient 5.1.5 | ||
| - Microsoft.Extensions.Caching.Memory 8.0.0 | ||
|
|
||
| #### .NET Standard | ||
|
|
||
| - Azure.Core 1.35.0 | ||
| - Azure.Security.KeyVault.Keys 4.5.0 | ||
| - Microsoft.Data.SqlClient 5.1.5 | ||
| - Microsoft.Extensions.Caching.Memory 6.0.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 5.1 Releases | ||
|
|
||
| The following Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 5.1 stable releases have been shipped: | ||
|
|
||
| | Release Date | Description | Notes | | ||
| | :-- | :-- | :--: | | ||
| | 2024/02/01 | 5.1.0 | [release notes](5.1.0.md) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters