Re-encrypt

Prev Next

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

暗号文を指定されたマスターキーの最新バージョンで再暗号化します。AES256または RSA2048キータイプでのみリクエストできます。

リクエスト

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

メソッド URI
POST /keys/{keyTag}/re-encrypt

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
ciphertext String Required 平文を暗号化して作成された文字列
context String Conditional Base64でエンコードされた文字列データ
  • 収束暗号化(convergent encryption)が適用されたキーの使用時に必須
  • 最大50バイトまで入力可能
  • 同じデータを何度暗号化してもいつも同じ暗号文を作成

リクエスト例

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

  • ciphertextを Stringタイプでリクエスト
curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/re-encrypt' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "ciphertext": "{CIPHERTEXT}",
  "context": "{BASE64_CONTEXT}"
}'
  • ciphertextを Array<String>タイプでリクエスト
curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/re-encrypt' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "ciphertext": ["{CIPHERTEXT_1}", "{CIPHERTEXT_2}", "{CIPHERTEXT_3}"],
  "context": "{BASE64_CONTEXT}"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - 成功したかどうか
data Object - レスポンス結果
data.newCiphertext String - 暗号文(ciphertext)を指定されたマスターキーの最新バージョンで再暗号化した文字列

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

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

レスポンス例

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

  • ciphertextを Stringタイプでリクエスト
{
    "code": "SUCCESS",
    "data": {
        "newCiphertext": "{CIPHERTEXT_NEW}"
    }
}
  • ciphertextを Array<String>タイプでリクエスト
{
    "code": "SUCCESS",
    "data": {
        "newCiphertext": [
            "{CIPHERTEXT_NEW_1}",
            "{CIPHERTEXT_NEW_2}",
            "{CIPHERTEXT_NEW_3}"
        ]
    }
}