調用Encrypt介面將明文加密為密文。
使用說明
Encrypt和AdvanceEncrypt都用於將明文資料加密為密文,區別為:
Encrypt:加密時使用密鑰的初始版本,加密後可以使用Decrypt或AdvanceDecrypt解密。
AdvanceEncrypt:加密時使用密鑰的主要版本,加密後需要使用AdvanceDecrypt解密。但目前僅KMS軟體密鑰管理執行個體中的對稱金鑰支援使用該介面。
如果您使用KMS軟體密鑰管理執行個體中的對稱金鑰,且密鑰開啟了自動輪轉,加密時請使用AdvanceEncrypt,以避免輪轉功能不生效。關於密鑰輪轉的相關內容,請參見密鑰輪轉。
關於密鑰規格、加密模式以及密鑰版本的詳細資料,請參見密鑰管理類型和密鑰規格。
注意事項
所有請求參數使用Protocol Buffers編碼後(即Request Body),內容長度不能超過3 MB,超過3 MB後服務端會拒絕處理並返回HTTP 413狀態代碼。建議單次使用對稱金鑰加解密的資料不超過6 KB,單次使用非對稱金鑰加解密的資料不超過1 KB,超過後請使用信封加密方案。詳細資料,請參見使用KMS密鑰進行信封加密。
單次加解密的資料量越大,網路傳輸失敗可能性越大,網路傳輸所需時間越長,KMS執行個體對資料進行加解密所需時間也越長。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
KeyId | string | 是 | key-hzz62f1cb66fa42qo**** | 密鑰的通用唯一識別碼。該參數也可以被指定為密鑰別名。 |
Plaintext | bytes | 是 | 位元據 | 待加密的明文資料。 |
Algorithm | string | 否 | AES_GCM | 密碼編譯演算法。 如果未指定本參數,KMS會使用密碼編譯演算法預設值。更多資訊,請參見密鑰管理類型和密鑰規格。 |
Iv | bytes | 否 | 位元據 | 對資料加密時使用的初始向量。 僅當密碼編譯演算法(Algorithm參數)為AES_GCM、AES_CBC時本參數有效。
如果未指定本參數,KMS將隨機產生。 重要 推薦您不指定本參數,由KMS隨機產生。 |
Aad | binary | 否 | 位元據 | 對資料加密時使用的GCM加密模式認證資料。 當密鑰是對稱金鑰、密碼編譯演算法(Algorithm)是AES_GCM或SM4_GCM時,您可以按需要使用本參數。 重要 如果指定了本參數,調用Decrypt解密時需要指定相同的參數。 |
PaddingMode | string | 否 | PKCS7_PADDING | 填充模式。 僅當密碼編譯演算法為AES_CBC或AES_ECB時,需要提供本參數。 取值:
|
響應資料
名稱 | 類型 | 樣本值 | 描述 |
Iv | bytes | 位元據 | 加密資料時使用的初始向量。 僅當密碼編譯演算法(Algorithm參數)為AES_GCM、AES_CBC時,本參數返回有效值,其他情境返回空值。 |
CiphertextBlob | bytes | 位元據 | 資料被指定祕密金鑰加密後的密文。 說明 當採用ECIES演算法時,返回的密文格式遵循SEC 1: Elliptic Curve Cryptography, Version 2.0標準。 |
KeyId | string | key-hzz62f1cb66fa42qo**** | 密鑰的通用唯一識別碼。如果請求中的KeyId參數使用的是密鑰別名,在響應中會返回別名對應的密鑰的通用唯一識別碼。 |
Algorithm | string | AES_GCM | 密碼編譯演算法。 |
PaddingMode | string | PKCS7_PADDING | 填充模式。僅當密碼編譯演算法(Algorithm參數)為AES_CBC或AES_ECB時,本參數返回有效值,其他情境返回空值。 |
RequestId | string | 475f1620-b9d3-4d35-b5c6-3fbdd941423d | 本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
錯誤碼
訪問公用錯誤碼查看更多錯誤碼。