Decrypt

Classic/VPC環境で利用できます。

キーで暗号化された暗号文を復号化します。AES256または RSA2048キータイプでのみリクエストできます。

注意

マスターキーで暗号化されて返されるデータはKMS prefix + 暗号文で構成されています。KMS prefixはncpkms:バージョン情報で構成されていて、復号化リクエスト時に指定されたキーバージョンで復号化されるため、暗号文と一緒に KMS prefixを正確に明示する必要があります。KMS prefixが正しくないと正確に復号化されません。任意に削除したり操作せずに、返された暗号化形式のままで管理してください。

ncpkms:v1:XjsPWPjqPrBi1N2DupSiSbX/ATkGmKA
---------- -------------------------------
KMS prefix             暗号文

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	API Gateway request signature v1: /keys/v1/{keyTag}/decrypt API Gateway request signature v2: /keys/v2/{keyTag}/decrypt

リクエストヘッダ

Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`keyTag`	String	Required	キータグキー名から派生したキーの固有 ID Get Key Listを通じて確認 REST APIで暗号化または復号化をリクエストする際に使用キータグは機密情報として扱われない

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`ciphertext`	Stringまたは Array<String>	Required	平文を暗号化して作成された文字列データ
`context`	String	Conditional	Base64でエンコードされた文字列データ収束暗号化(convergent encryption)が適用されたキーでデータを暗号化した時に使用した`context`パラメータの値を必ず入力

リクエスト例

リクエストのサンプルコードは次の通りです。

API Gateway request signature v1とciphertextを Stringタイプでリクエスト

curl --location --request POST 'https://kms.apigw.ntruss.com/keys/v1/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/decrypt' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v1: {API Gateway Signature}' \
--data '{
  "ciphertext": "{CIPHERTEXT}",
  "context": "{BASE64_CONTEXT}"
}'

API Gateway request signature v2とciphertextを Array<String>タイプでリクエスト

curl --location --request POST 'https://kms.apigw.ntruss.com/keys/v2/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/decrypt' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "ciphertext": ["{CIPHERTEXT_1}", "{CIPHERTEXT_2}", "{CIPHERTEXT_3}"],
  "context": "{BASE64_CONTEXT}"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	成功したかどうか
`msg`	String	-	レスオンスコード(`code`)の説明リクエスト成功(`SUCCESS`)時、空の値「""」と表示
`data`	Object	-	レスポンス結果
`data.plaintext`	Stringまたは Array<String>	-	復号化された文字列データ暗号化前の Base64でエンコードされた文字列データ

レスポンスステータスコード

Key Management Service APIで共通して使用されるレスポンスステータスコードの詳細は、Key Management Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

ciphertextを Stringタイプでリクエスト

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "plaintext": "{BASE64_PLAINTEXT}"
    }
}

ciphertextを Array<String>タイプでリクエスト

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "plaintext": [
            "{BASE64_PLAINTEXT_1}",
            "{BASE64_PLAINTEXT_2}",
            "{BASE64_PLAINTEXT_3}"
        ]
    }
}