wrap Key - wrap Key

Referenz

Service:: Key Vault

API Version:: 7.4

Umschließt einen symmetrischen Schlüssel mithilfe eines angegebenen Schlüssels.
Der WRAP-Vorgang unterstützt die Verschlüsselung eines symmetrischen Schlüssels mit einem Schlüsselverschlüsselungsschlüssel, der zuvor in einem Azure-Schlüsseltresor gespeichert wurde. Der WRAP-Vorgang ist nur für symmetrische Schlüssel unbedingt notwendig, die im Azure-Schlüsseltresor gespeichert sind, da der Schutz mit einem asymmetrischen Schlüssel mit dem öffentlichen Teil des Schlüssels ausgeführt werden kann. Dieser Vorgang wird für asymmetrische Schlüssel aus Gründen der Benutzerfreundlichkeit für Aufrufer unterstützt, die einen Schlüsselverweis besitzen, aber keinen Zugriff auf das öffentliche Schlüsselmaterial haben. Für diesen Vorgang ist die Berechtigung keys/wrapKey erforderlich.

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/wrapkey?api-version=7.4

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
key-name	path	True	string	Der Name des Schlüssels.
key-version	path	True	string	Die Version des Schlüssels.
vaultBaseUrl	path	True	string	Der Tresorname, z. B https://myvault.vault.azure.net. .
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
alg	True	JsonWebKeyEncryptionAlgorithm	Algorithmusbezeichner
value	True	string
aad		string	Zusätzliche Daten, die bei Verwendung authentifizierter Kryptoalgorithmen authentifiziert, aber nicht verschlüsselt/entschlüsselt werden müssen.
iv		string	Kryptografisch zufälliger, nicht wiederholender Initialisierungsvektor für symmetrische Algorithmen.
tag		string	Das Tag, das bei der Entschlüsselung mit einem authentifizierten Algorithmus authentifiziert werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	KeyOperationResult	Der umschlossene symmetrische Schlüssel.
Other Status Codes	KeyVaultError	Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

Wrapkey

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6/wrapkey?api-version=7.4

{
  "alg": "RSA1_5",
  "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}

Sample Response

Status code:: 200

{
  "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
  "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw"
}

Definitionen

Name	Beschreibung
Error	Der Schlüsseltresorserverfehler.
JsonWebKeyEncryptionAlgorithm	Algorithmusbezeichner
KeyOperationResult	Das Ergebnis des Schlüsselvorgangs.
KeyOperationsParameters	Die Schlüsseloperationsparameter.
KeyVaultError	Die Schlüsseltresorfehler-Ausnahme.

Error

Der Schlüsseltresorserverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der Schlüsseltresorserverfehler.
message	string	Die Fehlermeldung.

JsonWebKeyEncryptionAlgorithm

Algorithmusbezeichner

Name	Typ	Beschreibung
A128CBC	string
A128CBCPAD	string
A128GCM	string
A128KW	string
A192CBC	string
A192CBCPAD	string
A192GCM	string
A192KW	string
A256CBC	string
A256CBCPAD	string
A256GCM	string
A256KW	string
RSA-OAEP	string
RSA-OAEP-256	string
RSA1_5	string

KeyOperationResult

Das Ergebnis des Schlüsselvorgangs.

Name	Typ	Beschreibung
aad	string
iv	string
kid	string	Schlüsselbezeichner
tag	string
value	string

KeyOperationsParameters

Die Schlüsseloperationsparameter.

Name	Typ	Beschreibung
aad	string	Zusätzliche Daten, die bei Verwendung authentifizierter Kryptoalgorithmen authentifiziert, aber nicht verschlüsselt/entschlüsselt werden müssen.
alg	JsonWebKeyEncryptionAlgorithm	Algorithmusbezeichner
iv	string	Kryptografisch zufälliger, nicht wiederholender Initialisierungsvektor für symmetrische Algorithmen.
tag	string	Das Tag, das bei der Entschlüsselung mit einem authentifizierten Algorithmus authentifiziert werden soll.
value	string

KeyVaultError

Die Schlüsseltresorfehler-Ausnahme.

Name	Typ	Beschreibung
error	Error	Der Schlüsseltresorserverfehler.

Share via