GainPrivateKey

GainPrivateKey

Description

Querying a managed asymmetric private key. The returned value is the ciphertext of the private key encrypted using AES_128 symmetric encryption. You need to decrypt the ciphertext key before using it.

Request Parameters

Name

Type

Necessary or Not

Description

requestTime

String

Yes

Request time in the format of yyyyMMddhhmmssSSS.

appId

String

Yes

Unique identifier of the asymmetric private key, which is automatically assigned by KMS when the private key was created.

asyKeyType

String

Yes

Key type of the asymmetric key.

encryptVersion

String

No

Encryption version (encryption method used for the obtained password).

Optional field. You can use this parameter to distinguish between cryptographic modes. KMS is compatible with ECB mode and CBC mode AES encryption.

If you pass the parameter encryptVersion = “2.0”, it indicates CBC mode AES encryption.

If you do not pass a parameter, it is ECB mode AES encryption by default.

KMS supports only AES and ECB encryptions. Otherwise, you will receive an error report.

sign

String

Yes

Signature value. For more information, see Signature Algorithm (hexadecimal string).

Return Parameters

Name

Type

Description

Code

String

Return code. “SUCCESS” will be returned if the request is succeeded.

AppId

String

Signature value of the data after signing with the private key.

EncryptedPrivateKey

String

Ciphertext of the private key.

ResponseTime

String

Request time in the format of yyyyMMddhhmmssSSS.

Sign

String

For more information, see Signature Algorithm.

RequestId

String

ID of the current request.

Request Example

http:// kms-cn-shanghai.yun.pingan.com/?action= GainPrivateKey
          &appId =
          &sign=
      &requestTime=
      & encryptVersion=< encryptVersion >
          & asyKeyType =
          &<公共请求参数> 

Return Example

{     
      "Code":"SUCCESS",     
      "AppId":"app_id", 
      "EncryptedPrivateKey":"privateKey",  
             "ResponseTime":"time",      
      "Sign":"signatureValue"
      "RequestId":"f244ca16-c944-484f-9728-bb3e9c31643a",
      } 
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products