Key Management Service (KMS) のソフトウェアキー管理インスタンスにある対称キーで生成された暗号文を復号します。
操作の説明
この API は、AdvanceEncrypt、AdvanceGenerateDataKey、Encrypt、または GenerateDataKey の呼び出しによって暗号化された暗号文を復号します。キーは、ソフトウェアキー管理タイプの KMS インスタンスの対称キーである必要があります。
サポートされているキー仕様と暗号化モードの詳細については、「キーの種類と仕様」をご参照ください。
注意事項
Protocol Buffers エンコーディング後のリクエストボディは 3 MB 未満にしてください。リクエストボディが 3 MB を超える場合、サーバーはリクエストを拒否し、HTTP 413 を返します。
1 回の操作での暗号化と復号のデータサイズは 6 KB に制限してください。より大きなデータの場合は、エンベロープ暗号化を使用してください。
ペイロードが大きいと、ネットワーク障害のリスクが高まり、伝送時間が長くなり、KMS の処理レイテンシーが増加します。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
CiphertextBlob | bytes | はい | バイナリデータ | 復号する暗号文。 |
KeyId | string | いいえ | key-hzz62f1cb66fa42qo**** | キーのグローバルに一意な ID、またはキーにバインドされたエイリアス。Encrypt API または GenerateDataKey API を呼び出して生成された暗号文を復号する場合にのみ必要です。 |
Algorithm | string | いいえ | AES_GCM | 復号アルゴリズム。Encrypt API または GenerateDataKey API を呼び出して生成された暗号文を復号する場合にのみ必要です。暗号化時に使用したアルゴリズムと一致させる必要があります。 |
Iv | bytes | いいえ | バイナリデータ | 初期化ベクトル (IV) 。Algorithm が AES_GCM または AES_CBC に設定されており、Encrypt API または GenerateDataKey API を呼び出して生成された暗号文を復号する場合にのみ必要です。暗号化時に使用した IV と一致させる必要があります。有効な長さ：AES_CBC の場合は 16 バイト、AES_GCM の場合は 12 バイト。 |
Aad | bytes | いいえ | バイナリデータ | 追加認証データ (AAD) 。最大長：8,192 バイト。Algorithm が AES_GCM であり、暗号化時に AAD が指定された場合にのみ必要です。暗暗号化時に使用した AAD と一致させる必要があります。 |
PaddingMode | string | いいえ | PKCS7_PADDING | パディングモード。Algorithm が AES_CBC または AES_ECB の場合に必要です。暗号化時に使用したパディングモードと一致させる必要があります。有効な値：PKCS7_PADDING (デフォルト) ：PKCS#7 パディング。平文が L バイトの場合、システムは K - (L mod K) バイトのパディングを追加します。ここで K は暗号ブロックサイズです。NO_PADDING：パディングなし。平文の長さは暗号ブロックサイズの整数倍である必要があります。 |
レスポンスパラメーター
パラメーター | タイプ | 例 | 説明 |
Plaintext | bytes | バイナリデータ | 復号された平文。 |
KeyId | string | key-hzz62f1cb66fa42qo**** | 復号に使用されたキーのグローバルに一意な ID。リクエストでエイリアスが指定された場合、実際のキー ID が返されます。 |
KeyVersionId | string | key-hzz62f1cb66fa42qo**-17kedv** | 暗号文の復号に使用されたキーバージョンの ID。 |
Algorithm | string | AES_GCM | 復号アルゴリズム。 |
PaddingMode | string | PKCS7_PADDING | パディングモード。Algorithm が AES_CBC または AES_ECB の場合にのみ返されます。それ以外の場合は空になります。 |
RequestId | string | c0037a6d-7784-4ef2-a692-288fdcbc7b9d | リクエスト ID。トラブルシューティングに使用されます。 |
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
404 | Forbidden.OnlySymmetricKeySupported | The key %s is not a symmetric key. The API only supports symmetric keys. | 対称キーのみサポートされます。 |
500 | InternalFailure | Internal Failure. | 考えられる原因は、暗号文が要件を満たしていないこと (たとえば、暗号文が AdvanceEncrypt 操作を呼び出して生成されたものではない)、または指定されたキーが暗号化に使用されたキーと一致しないことです。 |
すべてのエラーコードのリストについては、「サービスエラーコード」をご参照ください。