New-SqlColumnMasterKeySettings
创建 SqlColumnMasterKeySettings 对象,该对象描述存储在任意指定的密钥存储提供程序和路径中的主密钥。
语法
New-SqlColumnMasterKeySettings
[-KeyStoreProviderName] <String>
[-KeyPath] <String>
[[-Signature] <String>]
[-KeyVaultAccessToken <String>]
[-ManagedHsmAccessToken <String>]
[-AllowEnclaveComputations]
[<CommonParameters>]
说明
New-SqlColumnMasterKeySettings cmdlet 创建一个 SqlColumnMasterKeySettings 内存中对象,该对象存储Always Encrypted列主密钥的属性:KeyStoreProviderName、KeyPath、AllowEnclaveComputations 和 Signature。 此 cmdlet 可用于自定义密钥存储提供程序,以及密钥存储提供程序名称和完全格式化的密钥路径已知时。
cmdlet 可以与保存列主密钥的密钥存储进行通信,以生成密钥元数据属性的签名。 如果密钥存储在 Azure 中,则需要为密钥保管库或持有密钥的托管 HSM 指定有效的身份验证令牌。 或者,在调用此 cmdlet 之前,可以使用 Add-SqlAzureAuthenticationContext 向 Azure 进行身份验证。
Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.
示例
示例 1:为 Azure 密钥保管库中未启用 enclaved 的列主密钥生成设置。
$cmkSettings = New-SqlColumnMasterKeySettings -KeyStoreProviderName 'AZURE_KEY_VAULT' -KeyPath 'https://myvault.vault.azure.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700'
示例 2:为自定义提供程序中的列主密钥生成设置
$cmkSettings = New-SqlColumnMasterKeySettings -KeyStoreProviderName 'CUSTOM_PROVIDER' -KeyPath '\\SecureNetworkShare\Keys\AlwaysEncrypted.key'
示例 3:为 Azure 密钥保管库 中的列主密钥生成设置,允许 enclave 计算并使用提供的签名进行签名。
$cmkSettings = New-SqlColumnMasterKeySettings -KeyStoreProviderName 'AZURE_KEY_VAULT' -KeyPath 'https://myvault.vault.azure.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700' -AllowEnclaveComputations -Signature '0x19BEB4F27F582FDBBD0C7E5F92CF161D79D5E7F5A5183F9C8E710252E7028A3654FBEAF834EE45925024F1A32BD3C6D7D92B46E38690830E20E0777607B073E6665EB05E39263C02557D1208ACECB2251A108D0DEFC25232B67FD223C590258C817292FAFCE2388507812D64A0AEC9E546B0B8E4B2F3EA436053CB158F3CF478C5F5EDA511D0F752F60C3B129BF21356A93368FCC7FD6FAA8DB4E919EB551F375181CA3F4D0404A811C99BD2C8D10C0003AC12B138371F2D76611768B4E84D44116C42F00D679B36D41FBD9467B58291B1F4348C7B422793DA0614EF980CA0A7F42B6D627AFA5A753F0869D2C2F9B0FD38289D5433CE9266C6F867334654BE12'
示例 4:为 Azure 密钥保管库中的列主密钥生成设置,允许 enclave 计算并自动签名。
# Connect to Azure account.
Import-Module Az.Accounts -MinimumVersion 2.2.0
Connect-AzAccount
# Obtain an access token for key vaults.
$keyVaultAccessToken = (Get-AzAccessToken -ResourceUrl https://vault.azure.net).Token
# Pass the token to the cmdlet. It will use the token to communicate with a key vault in Azure Key Vault to sign the column master key properties.
$cmkSettings = New-SqlColumnMasterKeySettings -KeyStoreProviderName 'AZURE_KEY_VAULT' -KeyPath 'https://myvault.vault.azure.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700' -AllowEnclaveComputations -KeyVaultAccessToken $keyVaultAccessToken
参数
-AllowEnclaveComputations
指定列主密钥是否允许 enclave 计算。 如果指定了 参数,则将允许服务器端安全 enclave 对受列主密钥保护的数据执行计算。 不适用于 SQL Server 2017 及更早版本。
Type: | SwitchParameter |
Position: | 2 |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyPath
指定物理主密钥的密钥存储内的路径。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyStoreProviderName
指定用于保护物理主密钥的密钥存储的提供程序名称。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVaultAccessToken
为 Azure 密钥保管库中的密钥保管库指定访问令牌。 如果指定的列主密钥存储在 Azure 密钥保管库的密钥保管库中,并且该 cmdlet 预期对密钥元数据进行签名,请使用此参数。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagedHsmAccessToken
指定 Azure 密钥保管库中托管 HSM 的访问令牌。 如果指定的列主密钥存储在 Azure 密钥保管库的托管 HSM 中,并且该 cmdlet 预期对密钥元数据进行签名,请使用此参数。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Signature
指定十六进制字符串,该字符串是列主密钥属性的数字签名。 客户端驱动程序可以验证签名,以确保列主密钥属性未被篡改。 仅当指定 了 AllowEnclaveComputations 时,才允许此参数。 如果指定 了 AllowEnclaveComputations ,但 未指定 Signature ,则 cmdlet 会自动计算签名并填充新的 SqlColumnMasterKeySettings 对象的 Signature 属性。
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |