Re-encrypt
    • PDF

    Re-encrypt

    • PDF

    Article summary

    Available in Classic and VPC

    Reencrypt the ciphertext with the most recent version of the specified master key. It can only be requested as an AES256 or RSA2048 key type.

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    POST/keys/{keyTag}/re-encrypt

    Request headers

    For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.

    Request path parameters

    You can use the following path parameters with your request:

    FieldTypeRequiredDescription
    keyTagStringRequiredKey tag
    • Unique identifier for the key derived from the key name
    • Check through Get key list
    • Use to request encryption or decryption with REST APIs
    • Key tags are not treated as confidential information

    Request body

    You can include the following data in the body of your request:

    FieldTypeRequiredDescription
    ciphertextStringRequiredString created by encrypting a plaintext
    contextStringConditionalBase64-encoded string data
    • Required when using keys with convergent encryption
    • Can be up to 50 bytes long
    • Always generate the same ciphertext, even when encrypting the same data multiple times

    Request example

    The request example is as follows:

    • Request ciphertext as String type
    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}"
    }'
    
    • Request ciphertext as Array<String> type
    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}"
    }'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    codeString-Success or Failure
    dataObject-Response result
    data.newCiphertextString-String that reencrypted the ciphertext (ciphertext) with the most recent version of the specified master key

    Response status codes

    For response status codes common to all Key Management Service APIs, see Key Management Service response status codes.

    Response example

    The response example is as follows:

    • Request ciphertext as String type
    {
        "code": "SUCCESS",
        "data": {
            "newCiphertext": "{CIPHERTEXT_NEW}"
        }
    }
    
    • Request ciphertext as Array<String> type
    {
        "code": "SUCCESS",
        "data": {
            "newCiphertext": [
                "{CIPHERTEXT_NEW_1}",
                "{CIPHERTEXT_NEW_2}",
                "{CIPHERTEXT_NEW_3}"
            ]
        }
    }
    

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.