external_kms_info

2023-08-16 03:57:14  Updated

external_kms_info is used to store some key management information.

Parameter Description
Type String
Default value Null
Value range NULL
Effective upon restart of OBServer node No

When you use an external key management system (KMS), you can use external_kms_info to store specific key management information. The sample code is as follows:

{
    "KMS_HOST": "TEST_SERVER",                     // The address of the KMS.
    "ROOT_CERT": "TEST_CERT",                       // The public key of the certificate.
    "PRIVATE_KEY": "TEST_PKEY",                     // The private key of the certificate.
    "PRIVATE_KEY_PHRASE": "TEST_PHRASE",   // The passphrase for the private key of the certificate.
    "SCENE": "HK",                                           // The scenario. Valid values: HK, ANT, HK_SM, and ANT_SM.
    "KEY_NAME": "TEST_NAME",                       // The name of the key.
    "CALLER": "TEST_CALLER"                         // The name of the application.
}

Contact Us