658      微信

GenerateDataKey__API 參考_密鑰管理服務-阿裏雲

生成一個密鑰，你可以用這個密鑰進行本地數據的加密。這個API返回一個DataKey的明文Plaintext以及DataKey加密後的密文CiphertextBlob 。DataKey的加密是用keyid對應的主密鑰加密的。可以調用Decrypt API進行解密。

• 注意

  • 我們建議您使用以下方式在本地進行數據加密：調用GenerateDataKey API ，使用返回的明文DataKey在本地加密數據，然後刪除內存中的明文DataKey。存儲加密過的密鑰CiphertextBlob和加密後的數據
  • 解密數據時，調用Decrypt API，用CiphertextBlob作為參數，調用成功，會返回DataKey的明文Plaintext，用Plaintext對本地加密的數據進行解密

• 請求格式

    KeyId="string"&KeySpec="string"&NumberOfBytes=number&EncryptionContext=json

• 請求參數

  • KeyId
    • 含義 : key的全局唯一標識符
    • 類型 : String
    • 是否必須 : 是
  • KeySpec
    • 含義 : 指定生成Datakey的加密算法以及Datakey大小，目前支持AES_128 或者 AES_256
    • 類型: String
    • 有效值: AES_256 | AES_128
    • 是否必須 : 否
  • NumberOfBytes(同時指定NumberOfBytes和KeySpec時，以NumberOfBytes為準)
    • 含義 : 生成的DataKey的長度
    • 類型 : integer
    • 有效值: 1 到 1024
    • 是否必須 : 否
  • EncryptionContext
    • 含義: key/value對的json字符串，如果指定了該參數，則在調用Decrypt API時需要提供同樣的參數，參見EncryptionContext說明
    • 類型: String
    • 有效值: EncryptionContext說明
    • 是否必須: 否

• 請求示例

https://kms.cn-hangzhou.aliyuncs.com/?Action=GenerateDataKey
&KeyId=<your-key-id>
&KeySpec=AES_256
&EncryptionContext={"Example":"Example"}
&<其他公共參數>

• 返回格式

{
    "CiphertextBlob": blob,  // blob為base64編碼後的String
    "KeyId": "string",
    "Plaintext": blob, // blob為base64編碼後的String
    "RequestId":"string"
}

• 返回參數

  • KeyId
    • 含義 : key的全局唯一標識符
    • 類型 : String
  • Plaintext
    • 含義 : 生成的DataKey的明文
    • 類型 : String
  • CiphertextBlob
    • 含義 : DataKey加密後的密文
    • 類型 : String
  • RequestId
    • 含義 : 隨機的訪問Id
    • 類型 : String

• 返回示例

//json response
{
    "CiphertextBlob": "CiphertextBlob",
    "KeyId": "KeyId",
    "Plaintext": "Plaintext",
    "RequestId": "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0"
}
//xml response
<KMS>
    <CiphertextBlob>CiphertextBlob</CiphertextBlob>
    <KeyId>KeyId</KeyId>
    <Plaintext>Plaintext</Plaintext>
    <RequestId>7021b6ec-4be7-4d3c-8a68-1e85d4d515a0</RequestId>
</KMS>