sp_describe_parameter_encryption (Transact-SQL)

  • [アーティクル]

適用対象: SQL Server 2016 (13.x) 以降 Azure SQL DatabaseAzure SQL Managed Instance

指定した Transact-SQL ステートメントとそのパラメーターを分析して、Always Encrypted機能を使用して保護されているデータベース列に対応するパラメーターを決定します。 暗号化された列に対応するパラメーターの暗号化メタデータを返します。

構文

sp_describe_parameter_encryption   
    [ @tsql = ] N'Transact-SQL_batch' ,   
    [ @params = ] N'parameters'   
[ ;]

引数

[ @tsql = ]'Transact-SQL_batch'
1 つ以上の Transact-SQL ステートメント。 Transact-SQL_batch nvarchar(n) または nvarchar(max) を指定できます。

[ @params = ]N'parameters'
@params は、Transact-SQL バッチのパラメーターの宣言文字列を提供します。これは、sp_executesqlに似ています。 パラメーターには、nvarchar(n) または nvarchar(max) を指定できます。

Transact-SQL_batch に埋め込まれているすべてのパラメーターの定義を含む 1 つの文字列です。 この文字列は Unicode 定数または Unicode 変数にする必要があります。 各パラメーター定義は、パラメーター名とデータ型で構成されます。 n は、追加のパラメーター定義を示すプレースホルダーです。 ステートメントで指定されるすべてのパラメーターは 、@paramsで定義する必要があります。 ステートメント内の Transact-SQL ステートメントまたはバッチにパラメーターが含まれていない場合は、 @params は必要ありません。 このパラメーターの既定値は NULL です。

戻り値

0 は成功を示します。 それ以外の場合は、エラーを示します。

結果セット

sp_describe_parameter_encryption は、次の 2 つの結果セットを返します。

  • データベース列用に構成された暗号化キーを記述する結果セット。指定された Transact-SQL ステートメントのパラメーターは に対応します。

  • 特定のパラメーターを暗号化する方法を記述する結果セット。 この結果セットは、最初の結果セットで説明されているキーを参照します。

最初の結果セットの各行には、キーのペアが記述されています。暗号化された列暗号化キーとそれに対応する列マスター キー。

列名 データ型 説明
column_encryption_key_ordinal int 結果セット内の行の ID。
database_id int データベース ID。
column_encryption_key_id int 列暗号化キー ID。注: この ID は、 sys.column_encryption_keys (Transact-SQL) カタログ ビューの行を表します。
column_encryption_key_version int 将来利用するために予約されています。 現在、常に 1 が含まれています。
column_encryption_key_metadata_version binary(8) 列暗号化キーの作成時刻を表すタイムスタンプ。
column_encryption_key_encrypted_value varbinary(4000) 列暗号化キーの暗号化された値。
column_master_key_store_provider_name sysname 列マスター キーを含むキー ストアのプロバイダーの名前。これは、列暗号化キーの暗号化された値を生成するために使用されました。
column_master_key_path nvarchar (4000) 列の暗号化キーの暗号化された値を生成するために使用された列マスター キーのキー パス。
column_encryption_key_encryption_algorithm_name sysname 列暗号化キーの暗号化値を生成するために使用される暗号化アルゴリズムの名前。

2 番目の結果セットの各行には、1 つのパラメーターの暗号化メタデータが含まれています。

列名 データ型 説明
parameter_ordinal int 結果セット内の行の ID。
parameter_name sysname @params引数で指定されたパラメーターの 1 つの名前。
column_encryption_algorithm tinyint 列に対して構成された暗号化アルゴリズムを示すコード。パラメーターは に対応します。 現在サポートされている値は、 AEAD_AES_256_CBC_HMAC_SHA_256の場合は 2 です。
column_encryption_type tinyint 列に対して構成された暗号化の種類を示すコード。パラメーターは に対応します。 サポートされる値は

0 - プレーンテキスト (列は暗号化されていません)

1 - 決定論的暗号化

2 - ランダム化された暗号化。
column_encryption_key_ordinal int 最初の結果セット内の行のコード。 参照される行は、列に対して構成された列暗号化キーを記述します。パラメーターは に対応します。
column_encryption_normalization_rule_version tinyint 型正規化アルゴリズムのバージョン番号。

解説

Always EncryptedをサポートするSQL Server クライアント ドライバーは、sp_describe_parameter_encryptionを自動的に呼び出して、アプリケーションによって発行されたパラメーター化されたクエリの暗号化メタデータを取得します。 その後、ドライバーは暗号化メタデータを使用して、Always Encryptedで保護されたデータベース列に対応するパラメーターの値を暗号化し、クエリをデータベース エンジンに送信する前に、アプリケーションによって送信されたプレーンテキスト パラメーター値を暗号化されたパラメーター値に置き換えます。

アクセス許可

データベースの [VIEW ANY COLUMN ENCRYPTION KEY DEFINITION]\(列暗号化キー定義の表示 \) および [VIEW ANY COLUMN MASTER KEY DEFINITION]\(列マスター キー定義の表示 \) アクセス許可が必要です。

例

CREATE COLUMN MASTER KEY [CMK1]  
WITH  
(  
       KEY_STORE_PROVIDER_NAME = N'MSSQL_CERTIFICATE_STORE',  
    KEY_PATH = N'CurrentUser/my/A66BB0F6DD70BDFF02B62D0F87E340288E6F9305'  
);  
GO  
  
CREATE COLUMN ENCRYPTION KEY [CEK1]  
WITH VALUES  
(  
       COLUMN_MASTER_KEY = [CMK1],  
    ALGORITHM = 'RSA_OAEP',  
    ENCRYPTED_VALUE =   
0x016E000001630075007200720065006E00740075007300650072002F006D007  
9002F00610036003600620062003000660036006400640037003000620064006  
6006600300032006200360032006400300066003800370065003300340030003  
200380038006500360066003900330030003500CA0D0CEC74ECADD1804CF991  
37B4BD06BBAB15D7EA74E0C249A779C7768A5B659E0125D24FF827F5EA8CA51  
7A8E197ECA1353BA814C2B0B2E6C8AB36E3AE6A1E972D69C3C573A963ADAB6  
686CF5D24F95FE43140C4F9AF48FBA7DF2D053F3B4A1F5693A1F905440F8015B  
DB43AF8A04BE4E045B89876A0097E5FBC4E6A3B9C3C0D278C540E46C53938B8  
C957B689C4DC095821C465C73117CBA95B758232F9E5B2FCC7950B8CA00AFE3  
74DE42847E3FBC2FDD277035A2DEF529F4B735C20D980073B4965B4542A3472  
3276A1646998FC6E1C40A3FDB6ABCA98EE2B447F114D2AC7FF8C7D51657550E  
C5C2BABFFE8429B851272086DCED94332CF18FA854C1D545A28B1EF4BE64F8E0  
35175C1650F6FC5C4702ACF99850A4542B3747EAEC0CC726E091B36CE24392D8  
01ECAA684DE344FECE05812D12CD72254A014D42D0EABDA41C89FC4F545E88B  
4B8781E5FAF40D7199D4842D2BFE904D209728ED4F527CBC169E2904F6E711FF8  
1A8F4C25382A2E778DD2A58552ED031AFFDA9D9D891D98AD82155F93C58202F  
C24A77F415D4F8EF22419D62E188AC609330CCBD97CEE1AEF8A18B0195883360  
4707FDF03B2B386487CC679D7E352D0B69F9FB002E51BCD814D077E82A09C14E  
9892C1F8E0C559CFD5FA841CEF647DAB03C8191DC46B772E94D579D8C80FE93C  
3827C9F0AE04D5325BC73111E07EEEDBE67F1E2A73580085  
);  
GO  
  
CREATE TABLE t1 (  
c1 INT ENCRYPTED WITH (  
    COLUMN_ENCRYPTION_KEY = [CEK1],   
    ENCRYPTION_TYPE = Randomized,   
    ALGORITHM = 'AEAD_AES_256_CBC_HMAC_SHA_256') NULL,  
);  
  
EXEC sp_describe_parameter_encryption N'INSERT INTO t1 VALUES(@c1)',  N'@c1 INT';

最初の結果セットを次に示します。

column_encryption_key_ordinal database_id column_encryption_key_id column_encryption_key_version column_encryption_key_metadata_version column_encryption_key_encrypted_value
1 5 1 1 0x99EDA60083A50000 0x016E000001630075007200720065006E00740075007300650072002F006D0079002F006100360036006200620030006600360064006400370030006200640066006600300032006200360032006400300066003800370065003300340030003200380038006500360066003900330030003500CA0D0CEC74ECADD1804CF99137B4BD06BBAB15D7EA74E0C249A779C7768A5B659E0125D24FF827F5EA8CA517A8E197ECA1353BA814C2B0B2E6C8AB36E3AE6A1E972D69C3C573A963ADAB6686CF5D24F95FE43140C4F9AF48FBA7DF2D053F3B4A1F5693A1F905440F8015BDB43AF8A04BE4E045B89876A0097E5FBC4E6A3B9C3C0D278C540E46C53938B8C957B689C4DC095821C465C73117CBA95B758232F9E5B2FCC7950B8CA00AFE374DE42847E3FBC2FDD277035A2DEF529F4B735C20D980073B4965B4542A34723276A1646998FC6E1C40A3FDB6ABCA98EE2B447F114D2AC7FF8C7D51657550EC5C2BABFFE8429B851272086DCED94332CF18FA854C1D545A28B1EF4BE64F8E035175C1650F6FC5C4702ACF99850A4542B3747EAEC0CC726E091B36CE24392D801ECAA684DE344FECE05812D12CD72254A014D42D0EABDA41C89FC4F545E88B4B8781E5FAF40D7199D4842D2BFE904D209728ED4F527CBC169E2904F6E711FF81A8F4C25382A2E778DD2A58552ED031AFFDA9D9D891D98AD82155F93C58202FC24A77F415D4F8EF22419D62E188AC609330CCBD97CEE1AEF8A18B01958833604707FDF03B2B386487CC679D7E352D0B69F9FB002E51BCD814D077E82A09C14E9892C1F8E0C559CFD5FA841CEF647DAB03C8191DC46B772E94D579D8C80FE93C3827C9F0AE04D5325BC73111E07EEEDBE67F1E2A73580085

(結果は続行されます。

column_master_key_store_provider_name column_master_key_path column_encryption_key_encryption_algorithm_name
MSSQL_CERTIFICATE_STORE CurrentUser/my/A66BB0F6DD70BDFF02B62D0F87E340288E6F9305 RSA_OAEP

2 番目の結果セットを次に示します。

parameter_ordinal parameter_name column_encryption_algorithm column_encryption_type
1 @c1 1 1

(結果は続行されます。

column_encryption_key_ordinal column_encryption_normalization_rule_version
1 1

参照

常に暗号化
Always Encryptedを使用してアプリケーションを開発する