SqlColumnEncryptionCspProvider Class

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.dll

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 Microsoft CAPI based Cryptographic Service Providers (CSP) with Always Encrypted.

public ref class SqlColumnEncryptionCspProvider : System::Data::SqlClient::SqlColumnEncryptionKeyStoreProvider

public class SqlColumnEncryptionCspProvider : System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider

type SqlColumnEncryptionCspProvider = class
    inherit SqlColumnEncryptionKeyStoreProvider

Public Class SqlColumnEncryptionCspProvider
Inherits SqlColumnEncryptionKeyStoreProvider

Inheritance: Object

SqlColumnEncryptionKeyStoreProvider
SqlColumnEncryptionCspProvider

Remarks

Enables storing Always Encrypted column master key keys in a store, such as a hardware security module (HSM), that supports the Microsoft CAPI based Cryptographic Service Providers (CSP).

Constructors

SqlColumnEncryptionCspProvider()

Initializes a new instance of the SqlColumnEncryptionCspProvider class.

Fields

ProviderName

A constant string for the provider name 'MSSQL_CSP_PROVIDER'.

Methods

DecryptColumnEncryptionKey(String, String, Byte[])	Decrypts the given encrypted value using an asymmetric key specified by the key path and algorithm. The key path will be in the format of [ProviderName]/KeyIdentifier and should be an asymmetric key stored in the specified CSP provider. The valid algorithm used to encrypt/decrypt the CEK is 'RSA_OAEP'.
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 CSP provider. The valid algorithm used to encrypt/decrypt the CEK is 'RSA_OAEP'.
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.
SignColumnMasterKeyMetadata(String, Boolean)	When implemented in a derived class, digitally signs the column master key metadata with the column master key referenced by the `masterKeyPath` parameter. The input values used to generate the signature should be the specified values of the `masterKeyPath` and `allowEnclaveComputations` parameters. (Inherited from SqlColumnEncryptionKeyStoreProvider)
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 sign the master key metadata consisting of (masterKeyPath, allowEnclaveComputations, providerName).
VerifyColumnMasterKeyMetadata(String, Boolean, Byte[])	When implemented in a derived class, this method is expected to verify the specified signature is valid for the column master key with the specified key path and the specified enclave behavior. The default implementation throws NotImplementedException. (Inherited from SqlColumnEncryptionKeyStoreProvider)

Applies to