SqlColumnEncryptionCertificateStoreProvider 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 implementation of the key store provider for Windows Certificate Store. This class enables using certificates stored in the Windows Certificate Store as column master keys. For details, see Always Encrypted.
public ref class SqlColumnEncryptionCertificateStoreProvider : Microsoft::Data::SqlClient::SqlColumnEncryptionKeyStoreProviderpublic class SqlColumnEncryptionCertificateStoreProvider : Microsoft.Data.SqlClient.SqlColumnEncryptionKeyStoreProvidertype SqlColumnEncryptionCertificateStoreProvider = class
inherit SqlColumnEncryptionKeyStoreProviderPublic Class SqlColumnEncryptionCertificateStoreProvider
Inherits SqlColumnEncryptionKeyStoreProvider- Inheritance
Constructors
| Name | Description |
|---|---|
| SqlColumnEncryptionCertificateStoreProvider() | |
Fields
| Name | Description |
|---|---|
| ProviderName |
The provider name. |
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 specified encrypted value of a column encryption key. The encrypted value is expected to be encrypted using the certificate with the specified key path and using the specified algorithm. The format of the key path should be "Local Machine/My/<certificate_thumbprint>" or "Current User/My/<certificate_thumbprint>". |
| 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 a column encryption key using the certificate with the specified key path and using the specified algorithm. The format of the key path should be "Local Machine/My/<certificate_thumbprint>" or "Current User/My/<certificate_thumbprint>". |
| 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) |
Digitally signs the column master key metadata with the column master key referenced by the |
| 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
|
| 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 masterkey 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) |