sp_describe_parameter_encryption (T-SQL)

Artikel
05/23/2023

Berlaku untuk: SQL Server 2016 (13.x) dan Azure SQL Database Azure SQL Managed Instance yang lebih baru

Menganalisis pernyataan Transact-SQL yang ditentukan dan parameternya, untuk menentukan parameter mana yang sesuai dengan kolom database yang dilindungi dengan menggunakan fitur Always Encrypted. Mengembalikan metadata enkripsi untuk parameter yang sesuai dengan kolom terenkripsi.

Sintaks

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

Argumen

[ @tsql = ] 'Transact-SQL_batch'
Satu atau beberapa pernyataan Transact-SQL. Transact-SQL_batch mungkin nvarchar(n) atau nvarchar(max).

[ @params = ] N'parameters'
@params menyediakan string deklarasi untuk parameter untuk batch Transact-SQL, yang mirip dengan sp_executesql. Parameter mungkin nvarchar(n) atau nvarchar(maks).

Adalah salah satu string yang berisi definisi semua parameter yang telah disematkan dalam transact-SQL_batch. String harus berupa konstanta Unicode atau variabel Unicode. Setiap definisi parameter terdiri dari nama parameter dan jenis data. n adalah tempat penampung yang menunjukkan definisi parameter tambahan. Setiap parameter yang ditentukan dalam pernyataan harus ditentukan dalam @params. Jika pernyataan Transact-SQL atau batch dalam pernyataan tidak berisi parameter, @params tidak diperlukan. NULL adalah nilai default untuk parameter ini.

Tampilkan Nilai

0 menunjukkan keberhasilan. Yang lain menunjukkan kegagalan.

Tataan Hasil

sp_describe_parameter_encryption mengembalikan dua kumpulan hasil:

Kumpulan hasil yang menjelaskan kunci kriptografi yang dikonfigurasi untuk kolom database, parameter pernyataan Transact-SQL yang ditentukan sesuai dengan.
Kumpulan hasil yang menjelaskan bagaimana parameter tertentu harus dienkripsi. Tataan hasil ini mereferensikan kunci yang dijelaskan dalam tataan hasil pertama.

Setiap baris kumpulan hasil pertama menjelaskan sepasang kunci; kunci enkripsi kolom terenkripsi dan kunci master kolom yang sesuai.

Nama kolom	Jenis data	Deskripsi
column_encryption_key_ordinal	int	Id baris dalam resultset.
database_id	int	Id database.
column_encryption_key_id	int	Id kunci enkripsi kolom. Catatan: id ini menunjukkan baris dalam tampilan katalog sys.column_encryption_keys (Transact-SQL ).
column_encryption_key_version	int	Disiapkan untuk penggunaan masa mendatang. Saat ini, selalu berisi 1.
column_encryption_key_metadata_version	biner(8)	Tanda waktu yang mewakili waktu pembuatan kunci enkripsi kolom.
column_encryption_key_encrypted_value	varbinary(4000)	Nilai terenkripsi dari kunci enkripsi kolom.
column_master_key_store_provider_name	nama sysname	Nama penyedia untuk penyimpanan kunci yang berisi kunci master kolom, yang digunakan untuk menghasilkan nilai terenkripsi kunci enkripsi kolom.
column_master_key_path	nvarchar(4000)	Jalur kunci kunci master kolom, yang digunakan untuk menghasilkan nilai terenkripsi kunci enkripsi kolom.
column_encryption_key_encryption_algorithm_name	nama sysname	Nama algoritma enkripsi yang digunakan untuk menghasilkan nilai enkripsi kunci enkripsi kolom.

Setiap baris kumpulan hasil kedua berisi metadata enkripsi untuk satu parameter.

Nama kolom	Jenis data	Deskripsi
parameter_ordinal	int	Id baris dalam tataan hasil.
parameter_name	nama sysname	Nama salah satu parameter yang ditentukan dalam argumen @params .
column_encryption_algorithm	kecil	Kode yang menunjukkan algoritma enkripsi yang dikonfigurasi untuk kolom, parameter sesuai dengan. Nilai yang saat ini didukung adalah: 2 untuk AEAD_AES_256_CBC_HMAC_SHA_256.
column_encryption_type	kecil	Kode yang menunjukkan jenis enkripsi yang dikonfigurasi untuk kolom, parameter sesuai dengan. Nilai yang didukung adalah: 0 - teks biasa (kolom tidak dienkripsi) 1 - enkripsi deterministik 2 - enkripsi acak.
column_encryption_key_ordinal	int	Kode baris dalam tataan hasil pertama. Baris yang direferensikan menjelaskan kunci enkripsi kolom yang dikonfigurasi untuk kolom, parameter sesuai dengan.
column_encryption_normalization_rule_version	kecil	Nomor versi algoritma normalisasi jenis.

Keterangan

Driver klien SQL Server, yang mendukung Always Encrypted, secara otomatis memanggil sp_describe_parameter_encryption untuk mengambil metadata enkripsi untuk kueri berparameter, yang dikeluarkan oleh aplikasi. Selanjutnya, driver menggunakan metadata enkripsi untuk mengenkripsi nilai parameter yang sesuai dengan kolom database yang dilindungi dengan Always Encrypted dan mengganti nilai parameter teks biasa, yang dikirimkan oleh aplikasi, dengan nilai parameter terenkripsi, sebelum mengirim kueri ke mesin database.

Izin

Memerlukan izin LIHAT DEFINISI KUNCI ENKRIPSI KOLOM APA PUN dan LIHAT DEFINISI KUNCI MASTER KOLOM APA PUN dalam database.

Contoh

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';

Berikut adalah tataan hasil pertama:

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

(Hasil berlanjut.)

column_master_key_store_provider_name	column_master_key_path	column_encryption_key_encryption_algorithm_name
MSSQL_CERTIFICATE_STORE	CurrentUser/my/A66BB0F6DD70BDFF02B62D0F87E340288E6F9305	RSA_OAEP

Berikut adalah tataan hasil kedua:

parameter_ordinal	parameter_name	column_encryption_algorithm	column_encryption_type
1	@c1	1	1