SqlColumnEncryptionCngProvider Class

Definition

Namespace:: Microsoft.Data.SqlClient

Assembly:: Microsoft.Data.SqlClient.dll

Package:: Microsoft.Data.SqlClient v1.0.19269.1

Package:: Microsoft.Data.SqlClient v1.1.4

Package:: Microsoft.Data.SqlClient v2.0.1

Package:: Microsoft.Data.SqlClient v2.1.4

Package:: Microsoft.Data.SqlClient v3.0.1

Package:: Microsoft.Data.SqlClient v3.1.0

Package:: Microsoft.Data.SqlClient v4.0.1

Package:: Microsoft.Data.SqlClient v4.1.0

Package:: Microsoft.Data.SqlClient v5.0.0

Package:: Microsoft.Data.SqlClient v5.1.0

Package:: Microsoft.Data.SqlClient v5.2.0

Package:: Microsoft.Data.SqlClient v6.0.2

Package:: Microsoft.Data.SqlClient v6.1.3

Package:: Microsoft.Data.SqlClient v7.0.3

Package:: Microsoft.Data.SqlClient v7.1.0

Source:: SqlColumnEncryptionCngProvider.cs

Source:: SqlColumnEncryptionCngProvider.Windows.cs

Source:: SqlColumnEncryptionCngProvider.Windows.cs

Source:: SqlColumnEncryptionCngProvider.Windows.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The CMK Store provider implementation for using the Microsoft Cryptography API: Next Generation (CNG) with Always Encrypted.

public ref class SqlColumnEncryptionCngProvider : Microsoft::Data::SqlClient::SqlColumnEncryptionKeyStoreProvider

public class SqlColumnEncryptionCngProvider : Microsoft.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider

type SqlColumnEncryptionCngProvider = class
    inherit SqlColumnEncryptionKeyStoreProvider

Public Class SqlColumnEncryptionCngProvider
Inherits SqlColumnEncryptionKeyStoreProvider

Inheritance: Object

SqlColumnEncryptionKeyStoreProvider
SqlColumnEncryptionCngProvider

Remarks

Enables storing Always Encrypted column master key keys in a store, such as a hardware security module (HSM), that supports the Microsoft Cryptography API: Next Generation (CNG).

Constructors

Name	Description
SqlColumnEncryptionCngProvider()

Fields

Name	Description
ProviderName	A constant string for the provider name `MSSQL_CNG_STORE`>.

Properties

Name	Description
ColumnEncryptionKeyCacheTtl	Gets or sets the lifespan of the decrypted column encryption key in the cache. Once the timespan has elapsed, the decrypted column encryption key is discarded and must be revalidated. (Inherited from SqlColumnEncryptionKeyStoreProvider)

Methods

Name	Description
DecryptColumnEncryptionKey(String, String, Byte[])	Decrypts the given encrypted value using an asymmetric key specified by the key path and the specified algorithm. The key path will be in the format of `[ProviderName]/KeyIdentifier` and should be an asymmetric key stored in the specified CNG key store provider. The valid algorithm used to encrypt/decrypt the CEK is `RSA_OAEP`.
DecryptColumnEncryptionKeyAsync(String, String, Byte[], CancellationToken)	Asynchronously decrypts the specified encrypted value of a column encryption key. The encrypted value is expected to be encrypted using the column master key with the specified key path and using the specified algorithm. (Inherited from SqlColumnEncryptionKeyStoreProvider)
EncryptColumnEncryptionKey(String, String, Byte[])	Encrypts the given plain text column encryption key using an asymmetric key specified by the key path and the specified algorithm. The key path will be in the format of `[ProviderName]/KeyIdentifier` and should be an asymmetric key stored in the specified CNG key store provider. The valid algorithm used to encrypt/decrypt the CEK is `RSA_OAEP`.
EncryptColumnEncryptionKeyAsync(String, String, Byte[], CancellationToken)	Asynchronously encrypts a column encryption key using the column master key with the specified key path and using the specified algorithm. (Inherited from SqlColumnEncryptionKeyStoreProvider)
SignColumnMasterKeyMetadata(String, Boolean)	Throws a NotSupportedException exception in all cases.
SignColumnMasterKeyMetadataAsync(String, Boolean, CancellationToken)	When implemented in a derived class, asynchronously signs the column master key metadata with the column master key referenced by the `masterKeyPath` parameter. (Inherited from SqlColumnEncryptionKeyStoreProvider)
VerifyColumnMasterKeyMetadata(String, Boolean, Byte[])	This function must be implemented by the corresponding Key Store providers. This function should use an asymmetric key identified by a key path and verify the master key metadata consisting of (masterKeyPath, allowEnclaveComputations, providerName).
VerifyColumnMasterKeyMetadataAsync(String, Boolean, Byte[], CancellationToken)	When implemented in a derived class, asynchronously verifies the specified signature is valid for the column master key with the specified key path and the specified enclave behavior. The default implementation returns a faulted task with NotImplementedException. (Inherited from SqlColumnEncryptionKeyStoreProvider)

Applies to