Overview
tde_method specifies the method for transparent tablespace encryption.
Privilege requirements
Query parameters
Both the
systenant and all user tenants can query this parameter using theSHOW PARAMETERSstatement or theGV$OB_PARAMETERSview.Modify parameters
Both the
systenant and user tenants can use theALTER SYSTEM SETstatement to modify this parameter for a user tenant.
Attributes
Attribute |
Description |
|---|---|
| Parameter type | String |
| Default Value | none |
| Value range |
|
| Modifiable | Yes, you can use theALTER SYSTEM SETStatement modification. |
| Whether to restart the OBServer node for the change to take effect | No, the setting takes effect immediately. |
Usage instructions
tde_method is a prerequisite configuration for the data encryption feature. Different encryption features have different requirements for the value of tde_method:
Encryption feature |
Supported tde_methodValue |
Description |
|---|---|---|
| Transparent Data Encryption (TDE) | NononeValue; recommended for OBCloud deploymentobcloud, recommended for private cloud OCP deploymentocp |
For more information, see Overview of database transparent encryption. |
| Column encryption | NononeValue; recommended for OBCloud deployment.obcloud, recommended for private cloud OCP deploymentocp |
For more information, see Column encryption overview. |
| Function Encryption | NononeValue; recommended for OBCloud deploymentobcloud, recommended for private cloud OCP deploymentocp |
For more information, see ENHANCED_AES_ENCRYPT. |
Description of obcloud mode
The obcloud option is used for OBCloud public cloud scenarios: the master key is managed by the OceanBase Cloud KMS service.
The specific usage is as follows:
Enable encryption: Use the
obcloudunified KMS proxy service for master key management.ALTER SYSTEM SET tde_method = 'obcloud';Configure parameters: In the
external_kms_infoparameter, configure the attributes required for the KMS proxy service:kms_host: the endpoint of the OceanBase Cloud KMS service.access_key_id: The access key used for signature authentication.access_key_secret: The SK used for signature authentication.cmk_id: The CMK ID.
Description of ocp mode
ocp: Used in private cloud scenarios, where the master key is managed by the OCP KMS proxy service.
The specific usage is as follows:
Enable encryption: Use the
ocpprivate cloud OCP KMS proxy service for master key management.ALTER SYSTEM SET tde_method = 'ocp';Configure parameters: In the
external_kms_infoparameter, configure the attributes required for the KMS proxy service:kms_host: The endpoint of the OCP KMS service.access_key_id: The access key used for signature authentication.access_key_secret: The SK used for signature authentication.cmk_id: The CMK ID.
Configuration example
Set the transparent tablespace encryption method to internal.
obclient> ALTER SYSTEM SET tde_method= 'internal';
Set the transparent tablespace encryption method to obcloud (applicable to OBCloud deployment. You must also configure external_kms_info. The following values are examples; replace them with your actual endpoint and key information).
obclient> ALTER SYSTEM SET tde_method = 'obcloud';
obclient> ALTER SYSTEM SET external_kms_info = '{
"kms_host": "https://kms.example.oceanbase.com",
"access_key_id": "LTAI****************",
"access_key_secret": "your_access_key_secret",
"cmk_id": "your_customer_master_key_id"
}';
Set the transparent tablespace encryption method to ocp.
obclient> ALTER SYSTEM SET tde_method= 'ocp';
References
- For more information about transparent data encryption, see Overview of database transparent encryption.
- For more information about column encryption, see Column encryption overview.
- For more information about AES encryption and decryption using manual function calls, see ENHANCED_AES_ENCRYPT and ENHANCED_AES_DECRYPT.