wrap Key - wrap Key

サービス:: Key Vault

API バージョン:: 7.4

指定したキーを使用して対称キーをラップします。
WRAP 操作では、以前に Azure Key Vault に格納されているキー暗号化キーを使用した対称キーの暗号化がサポートされています。 WRAP 操作は、Azure Key Vault に格納されている対称キーに対してのみ厳密に必要です。非対称キーによる保護は、キーの公開部分を使用して実行できるためです。この操作は、キー参照があるが公開キーマテリアルにアクセスできない呼び出し元にとって便利な方法として、非対称キーに対してサポートされます。この操作には、keys/wrapKey アクセス許可が必要です。

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

URI パラメーター

名前	/	必須	型	説明
key-name	path	True	string	キーの名前。
key-version	path	True	string	キーのバージョン。
vaultBaseUrl	path	True	string	コンテナー名 (`https://myvault.vault.azure.net`など)。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
alg	True	JsonWebKeyEncryptionAlgorithm minLength: 1	アルゴリズム識別子
value	True	string (base64url)
aad		string (base64url)	認証された暗号化アルゴリズムを使用する場合は、認証するが暗号化/暗号化解除を行わない追加データ。
iv		string (base64url)	対称アルゴリズムに対する暗号的にランダムな非繰り返し初期化ベクトル。
tag		string (base64url)	認証されたアルゴリズムを使用して復号化を実行するときに認証するタグ。

応答

名前	型	説明
200 OK	KeyOperationResult	ラップされた対称キー。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明する Key Vault エラー応答。

例

Wrapkey

要求のサンプル

HTTP

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

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
Error	キーコンテナーサーバーエラー。
JsonWebKeyEncryptionAlgorithm	アルゴリズム識別子
KeyOperationResult	キー操作の結果。
KeyOperationsParameters	主要な操作パラメーター。
KeyVaultError	キーコンテナーのエラー例外。

Error

Object

キーコンテナーサーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	キーコンテナーサーバーエラー。
message	string	エラーメッセージ。

JsonWebKeyEncryptionAlgorithm

列挙

アルゴリズム識別子

値	説明
A128CBC
A128CBCPAD
A128GCM
A128KW
A192CBC
A192CBCPAD
A192GCM
A192KW
A256CBC
A256CBCPAD
A256GCM
A256KW
RSA-OAEP
RSA-OAEP-256
RSA1_5

KeyOperationResult

Object

キー操作の結果。

名前	型	説明
aad	string (base64url)
iv	string (base64url)
kid	string	キー識別子
tag	string (base64url)
value	string (base64url)

KeyOperationsParameters

Object

主要な操作パラメーター。

名前	型	説明
aad	string (base64url)	認証された暗号化アルゴリズムを使用する場合は、認証するが暗号化/暗号化解除を行わない追加データ。
alg	JsonWebKeyEncryptionAlgorithm minLength: 1	アルゴリズム識別子
iv	string (base64url)	対称アルゴリズムに対する暗号的にランダムな非繰り返し初期化ベクトル。
tag	string (base64url)	認証されたアルゴリズムを使用して復号化を実行するときに認証するタグ。
value	string (base64url)

KeyVaultError

Object

キーコンテナーのエラー例外。

名前	型	説明
error	Error	キーコンテナーサーバーエラー。

次の方法で共有

wrap Key - wrap Key

URI パラメーター

要求本文

応答

例

Wrapkey

要求のサンプル

応答のサンプル

定義

Error

JsonWebKeyEncryptionAlgorithm

KeyOperationResult

KeyOperationsParameters

KeyVaultError