SqlColumnEncryptionCngProvider Class
Definition
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.
For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient.
public ref class SqlColumnEncryptionCngProvider : System::Data::SqlClient::SqlColumnEncryptionKeyStoreProviderpublic class SqlColumnEncryptionCngProvider : System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvidertype SqlColumnEncryptionCngProvider = class
inherit SqlColumnEncryptionKeyStoreProviderPublic Class SqlColumnEncryptionCngProvider
Inherits SqlColumnEncryptionKeyStoreProvider- Inheritance
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() |
Initializes a new instance of the SqlColumnEncryptionCngProvider class. For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient. |
Fields
| Name | Description |
|---|---|
| ProviderName |
A constant string for the provider name 'MSSQL_CNG_STORE'. For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient. |
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'. For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient. |
| 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'. For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| SignColumnMasterKeyMetadata(String, Boolean) |
Throws a NotSupportedException exception in all cases. For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient. |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| 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). For new development, use Microsoft.Data.SqlClient. This page documents System.Data.SqlClient. |
