Skip to content

Commit d150725

Browse files
AKV provider docs update + remove unused delegate (#964)
1 parent 8e9a77c commit d150725

File tree

1 file changed

+12
-31
lines changed

1 file changed

+12
-31
lines changed

src/Microsoft.Data.SqlClient/add-ons/AzureKeyVaultProvider/SqlColumnEncryptionAzureKeyVaultProvider.cs

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,26 @@ namespace Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider
1414
{
1515
/// <summary>
1616
/// Implementation of column master key store provider that allows client applications to access data when a
17-
/// column master key is stored in Microsoft Azure Key Vault. For more information on Always Encrypted, please refer to: https://aka.ms/AlwaysEncrypted.
17+
/// column master key is stored in Microsoft Azure Key Vault.
18+
///
19+
/// For more information on Always Encrypted, please refer to: https://aka.ms/AlwaysEncrypted.
1820
///
1921
/// A Column Encryption Key encrypted with certificate store provider should be decryptable by this provider and vice versa.
2022
///
21-
/// Envelope Format for the encrypted column encryption key
22-
/// version + keyPathLength + ciphertextLength + keyPath + ciphertext + signature
23+
/// Envelope Format for the encrypted column encryption key :
24+
/// version + keyPathLength + ciphertextLength + keyPath + ciphertext + signature
2325
///
24-
/// version: A single byte indicating the format version.
25-
/// keyPathLength: Length of the keyPath.
26-
/// ciphertextLength: ciphertext length
27-
/// keyPath: keyPath used to encrypt the column encryption key. This is only used for troubleshooting purposes and is not verified during decryption.
28-
/// ciphertext: Encrypted column encryption key
29-
/// signature: Signature of the entire byte array. Signature is validated before decrypting the column encryption key.
26+
/// - version: A single byte indicating the format version.
27+
/// - keyPathLength: Length of the keyPath.
28+
/// - ciphertextLength: ciphertext length
29+
/// - keyPath: keyPath used to encrypt the column encryption key. This is only used for troubleshooting purposes and is not verified during decryption.
30+
/// - ciphertext: Encrypted column encryption key
31+
/// - signature: Signature of the entire byte array. Signature is validated before decrypting the column encryption key.
3032
/// </summary>
3133
/// <remarks>
3234
/// <format type="text/markdown"><![CDATA[
3335
/// ## Remarks
34-
///
35-
/// **SqlColumnEncryptionAzureKeyVaultProvider** is implemented for Microsoft.Data.SqlClient and supports .NET Framework 4.6.1+ and .NET Core 2.1+.
36-
/// The provider name identifier for this implementation is "AZURE_KEY_VAULT" and it is not registered in driver by default.
37-
/// Client applications must call the <xref=Microsoft.Data.SqlClient.SqlConnection.RegisterColumnEncryptionKeyStoreProviders> API only once in the lifetime of the driver to register this custom provider by implementing a custom Authentication Callback mechanism.
38-
///
39-
/// Once the provider is registered, it can used to perform Always Encrypted operations by creating Column Master Key using Azure Key Vault Key Identifier URL.
40-
///
41-
/// ## Example
42-
///
43-
/// Sample C# applications to demonstrate Always Encrypted use with Azure Key Vault are available at links below:
44-
///
45-
/// - [Example: Using Azure Key Vault with Always Encrypted](~/connect/ado-net/sql/azure-key-vault-example.md)
46-
/// - [Example: Using Azure Key Vault with Always Encrypted with enclaves enabled](~/connect/ado-net/sql/azure-key-vault-enclave-example.md)
36+
/// For more information, see: [Using the Azure Key Vault Provider](/sql/connect/ado-net/sql/sqlclient-support-always-encrypted#using-the-azure-key-vault-provider)
4737
/// ]]></format>
4838
/// </remarks>
4939
public class SqlColumnEncryptionAzureKeyVaultProvider : SqlColumnEncryptionKeyStoreProvider
@@ -322,13 +312,4 @@ private byte[] CompileMasterKeyMetadata(string masterKeyPath, bool allowEnclaveC
322312

323313
#endregion
324314
}
325-
326-
/// <summary>
327-
/// The authentication callback delegate which is to be implemented by the client code
328-
/// </summary>
329-
/// <param name="authority"> Identifier of the authority, a URL. </param>
330-
/// <param name="resource"> Identifier of the target resource that is the recipient of the requested token, a URL. </param>
331-
/// <param name="scope"> The scope of the authentication request. </param>
332-
/// <returns> access token </returns>
333-
public delegate Task<string> AuthenticationCallback(string authority, string resource, string scope);
334315
}

0 commit comments

Comments
 (0)