ローカルデータ暗号化用のランダムなデータキー (DK) を生成します。
操作説明
-
Resource Access Management (RAM) ユーザーまたは RAM ロールがこの API オペレーションの呼び出しを行うために必須となるアクセスポリシーの詳細については、「アクセスコントロール」を参照してください。
-
この API オペレーションは、共有ゲートウェイまたは専用ゲートウェイを通じて呼び出しできます。詳細については、「Alibaba Cloud SDK」を参照してください。
共有ゲートウェイ: インターネットまたは VPC エンドポイント経由で KMS にアクセスします。このメソッドでは、パブリックネットワークアクセスを有効にする必要があります。詳細については、「インターネット経由での KMS インスタンスのアクセスキー」を参照してください。
専用ゲートウェイ: KMS プライベートエンドポイント (
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com) 経由で KMS にアクセスします。
QPS 制限
共有ゲートウェイ: この API オペレーションのユーザーごとの QPS 制限は、1 秒あたり 1,000 回の呼び出しです。制限を超えると、API の呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。API の呼び出しは適切な周波数で行ってください。
専用ゲートウェイ: この API オペレーションのユーザーごとの QPS 制限は、KMS インスタンスのコンピューティングパフォーマンスのスペックによって異なります。詳細については、「パフォーマンスデータ」を参照してください。
説明
ランダムに生成されたデータキー (DK) は、指定されたカスタマーマスターキー (CMK) を使用して暗号化され、DK の暗号文とプレーンテキストが返されます。返された DK のプレーンテキストを使用して、KMS 外のローカルでデータを暗号化できます。暗号化されたデータを保存するときは、DK の暗号文も一緒に保存する必要があります。DK のプレーンテキストは応答の Plaintext フィールドから取得でき、DK の暗号文は CiphertextBlob フィールドから取得できます。
リクエストで指定された CMK は、DK の暗号化にのみ使用され、DK の生成には関与しません。KMS は、ランダムに生成された DK を Record または保存しません。DK の暗号文の永続化はユーザーの責任です。
ローカルでデータを暗号化するには、次のメソッドを使用することを推奨します。
-
GenerateDataKey 操作を呼び出して、データ暗号化用のキーを取得します。
-
応答の Plaintext フィールドで返された DK のプレーンテキストを使用して、ローカルでオフラインデータ暗号化を完了し、その後メモリから DK のプレーンテキストを消去します。
-
応答の CiphertextBlob フィールドで返された DK の暗号文を、ローカルで暗号化されたデータと一緒に保存します。
ローカルでデータを復号するには:
Decrypt 操作を呼び出して、ローカルストレージ内の DK の暗号文を復号します。この操作は、DK のプレーンテキストを返します。
DK のプレーンテキストを使用して、ローカルでオフラインデータの復号を完了し、その後メモリから DK のプレーンテキストを消去します。
この Topic では、ID が key-hzz630494463ejqjx**** のキーに対してランダムな DK を生成する例を示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
kms:GenerateDataKey |
get |
*Key。
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| KeyId |
string |
必須 |
キーの ID。キーのエイリアスまたは Amazon リソースネーム (ARN) を指定することもできます。エイリアスの詳細については、「キーエイリアスの管理」を参照してください。 説明
別の Alibaba Cloud アカウントに属するキーにアクセスする場合は、キーの ARN を入力する必要があります。キーの ARN は |
key-hzz630494463ejqjx**** |
| KeySpec |
string |
任意 |
生成される DK の長さを指定します。有効な値:
説明
DK の長さを指定するには、KeySpec または NumberOfBytes を使用します。どちらのパラメーターも指定されていない場合、KMS は 256 ビットの DK を生成します。両方のパラメーターが指定されている場合、KMS は KeySpec パラメーターを無視します。 |
AES_256 |
| NumberOfBytes |
integer |
任意 |
生成される DK の長さをバイト単位で指定します。 有効な値: 1~1024。 デフォルト値:
|
256 |
| EncryptionContext |
object |
任意 |
キーと値のペアの JSON 文字列。 このパラメーターを指定した場合、 Decrypt 操作の呼び出し時に同じパラメーターを指定する必要があります。詳細については、「 EncryptionContext 」を参照してください。 |
{"Example":"Example"} |
| DryRun |
string |
任意 |
ドライランモードを有効にするかどうかを指定します。有効な値:
デフォルト値: false。 ドライランモードは、API の呼び出しをテストし、リソースに対する必須の権限があるかどうかを確認し、リクエストパラメーターが正しく設定されているかどうかをチェックするために使用されます。ドライランモードが有効な場合、KMS は常に失敗を返し、失敗の原因を提供します。原因には次のものがあります。
|
false |
| Recipient |
string |
任意 |
信頼できる環境の認証情報。
AttestationDocument の構造:
|
{ "AttestationDocument":"base64-encoded-attestion-document", "KeyEncryptionAlgorithm":"RSAES_OAEP_SHA_256" } |
共通リクエストパラメーターの詳細については、「共通パラメーター」を参照してください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| KeyVersionId |
string |
キーバージョンの ID。プライマリキーバージョンのグローバル一意識別子です。 |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| KeyId |
string |
キーの ID。リクエストの KeyId パラメーターがキーのエイリアスまたは Amazon リソースネーム (ARN) にセットされている場合、キー ID も応答で返されます。 |
key-hzz630494463ejqjx**** |
| CiphertextBlob |
string |
指定されたキーのプライマリバージョンを使用して暗号化する、DK の暗号文。 |
ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS**** |
| RequestId |
string |
リクエストの ID。Alibaba Cloud によってリクエストに対して生成される一意の識別子であり、問題のトラブルシューティングと特定に使用できます。 |
7021b6ec-4be7-4d3c-8a68-1e85d4d515a0 |
| Plaintext |
string |
Base64 エンコードされた DK のプレーンテキスト。 |
QmFzZTY0IGVuY29kZWQgcGxhaW50**** |
| CiphertextForRecipient |
string |
Recipient パラメーターが渡された場合、プレーンテキストの DK は Recipient の extendUserData 内の公開鍵を使用して暗号化する処理が行われ、結果は Base64 エンコードされます。 重要 このパラメーターは、専用ゲートウェイを通じて API オペレーションの呼び出しを行う場合にのみ効果があります。 |
NIahY6pgjK4ZMP2R0EmsmBqntrv0AI2rcDyU7Su6uOT9Le7EOvlCpjHJfr9z3M0vkfulQoyuETmKSpYDfixE3auE4MwxloT6D9Gfsk6hm5FV2iAxL//Ms2kLv6K4z6yGi7lKm2yjX4***== |
例
成功レスポンス
JSONJSON
{
"KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId": "key-hzz630494463ejqjx****",
"CiphertextBlob": "ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****",
"RequestId": "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0",
"Plaintext": "QmFzZTY0IGVuY29kZWQgcGxhaW50****",
"CiphertextForRecipient": "NIahY6pgjK4ZMP2R0EmsmBqntrv0AI2rcDyU7Su6uOT9Le7EOvlCpjHJfr9z3M0vkfulQoyuETmKSpYDfixE3auE4MwxloT6D9Gfsk6hm5FV2iAxL//Ms2kLv6K4z6yGi7lKm2yjX4***=="
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | UnsupportedOperation | This action is not supported. | |
| 404 | Forbidden.AliasNotFound | The specified Alias is not found. | |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | |
| 409 | Rejected.Disabled | The request was rejected because the key state is Disabled. | |
| 409 | Rejected.PendingDeletion | The request was rejected because the key state is PendingDeletion. | |
| 409 | Rejected.Unavailable | The request was rejected because the key state is Unavailable. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。