sp_describe_parameter_encryption (Transact-SQL)

Gilt für: SQL Server 2016 (13.x) und höher Azure SQL-Datenbank Azure SQL Managed Instance

Analysiert die angegebene Transact-SQL-Anweisung und deren Parameter, um zu bestimmen, welche Parameter Datenbankspalten entsprechen, die mithilfe des Features "Immer verschlüsselt" geschützt sind. Gibt Verschlüsselungsmetadaten für die Parameter zurück, die verschlüsselten Spalten entsprechen.

Syntax

sp_describe_parameter_encryption
    [ @tsql = ] N'tsql'
    [ , [ @params = ] N'@parameter_name data_type [ , ... n ]' ]
[ ; ]

Argumente

[ @tsql = ] 'tsql'

Mindestens eine Transact-SQL-Anweisung. @tsql kann nvarchar(n) oder nvarchar(max)sein.

[ @params = ] N'@parameter_name data_type [ ,... n ]'

@params stellt eine Deklarationszeichenfolge für Parameter für @tsql bereit, die ähnlich istsp_executesql. Parameter können nvarchar(n) oder nvarchar(max)sein.

Eine Zeichenfolge, die die Definitionen aller Parameter enthält, die in transact-SQL_batch eingebettet sind. Die Zeichenfolge muss eine Unicode-Konstante oder eine Unicode-Variable sein. Jede Parameterdefinition besteht aus einem Parameternamen und einem Datentyp. n ist ein Platzhalter für zusätzlicher Parameterdefinitionen. n ist ein Platzhalter für zusätzlicher Parameterdefinitionen. Jeder in der Anweisung angegebene Parameter muss in @params definiert werden. Wenn die Transact-SQL-Anweisung oder der Batch in der Anweisung keine Parameter enthält, ist @params nicht erforderlich. NULL ist der Standardwert für diesen Parameter.

Rückgabewert

0 gibt an, dass der Erfolg erfolgreich ist. Alles andere deutet auf Fehler hin.

Resultset

sp_describe_parameter_encryption gibt zwei Resultsets zurück:

• Das Resultset, das kryptografische Schlüssel beschreibt, die für Datenbankspalten konfiguriert sind, entsprechen den Parametern der angegebenen Transact-SQL-Anweisung.

• Das Resultset, das beschreibt, wie bestimmte Parameter verschlüsselt werden sollen. Dieses Resultset verweist auf die schlüssel, die im ersten Resultset beschrieben werden.

Jede Zeile des ersten Resultsets beschreibt ein Schlüsselpaar: einen verschlüsselten Spaltenverschlüsselungsschlüssel und den entsprechenden Spaltenmasterschlüssel (CMK).

Jede Zeile des zweiten Resultsets enthält Verschlüsselungsmetadaten für einen Parameter.

Hinweise

Ein SQL Server-Clienttreiber, der Always Encrypted unterstützt, ruft automatisch Aufrufe sp_describe_parameter_encryption zum Abrufen von Verschlüsselungsmetadaten für parametrisierte Abfragen ab, die von der Anwendung ausgegeben werden. Anschließend verwendet der Treiber die Verschlüsselungsmetadaten, um die Werte von Parametern zu verschlüsseln, die Datenbankspalten entsprechen, die mit Always Encrypted geschützt sind. Er ersetzt die von der Anwendung übermittelten Nur-Text-Parameterwerte durch die verschlüsselten Parameterwerte, bevor die Abfrage an das Datenbankmodul gesendet wird.

Berechtigungen

Sie benötigen die Berechtigungen VIEW ANY COLUMN ENCRYPTION KEY DEFINITION und VIEW ANY COLUMN MASTER KEY DEFINITION in der Datenbank.

Beispiele

Im folgenden Beispiel wird der Wert für ENCRYPTED_VALUEanzeigezwecke abgeschnitten.

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 = 0x016E00000163007500720072<...> -- truncated in this example
);
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';

Dies ist der erste Resultset:

Dies ist der zweite Resultset:

Zugehöriger Inhalt

• Always Encrypted
• Entwickeln von Anwendungen mit Always Encrypted