SqlColumnEncryptionKeyStoreProvider Class

  • Reference

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

Base class for all key store providers. A custom provider must derive from this class and override its member functions and then register it using RegisterColumnEncryptionKeyStoreProviders(IDictionary<String,SqlColumnEncryptionKeyStoreProvider>), RegisterColumnEncryptionKeyStoreProvidersOnConnection(IDictionary<String,SqlColumnEncryptionKeyStoreProvider>) or RegisterColumnEncryptionKeyStoreProvidersOnCommand(IDictionary<String,SqlColumnEncryptionKeyStoreProvider>). For details see, Always Encrypted.

public ref class SqlColumnEncryptionKeyStoreProvider abstract
public abstract class SqlColumnEncryptionKeyStoreProvider
type SqlColumnEncryptionKeyStoreProvider = class
Public MustInherit Class SqlColumnEncryptionKeyStoreProvider
Inheritance
Object
SqlColumnEncryptionKeyStoreProvider
Derived

Constructors

SqlColumnEncryptionKeyStoreProvider()

Properties

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.

Methods

DecryptColumnEncryptionKey(String, String, Byte[])

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.
EncryptColumnEncryptionKey(String, String, Byte[])

Encrypts a column encryption key using the column master key with the specified key path and using the specified algorithm.
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.
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.

Applies to