Updated on 2026-07-07 GMT+08:00

Download Plugin

Overview: The system provides an encryption SDK for integration into customers' business systems, enabling seamless and transparent encryption/decryption functionality.

Description: The download plugin is a key feature of the Transparent Encryption Gateway. After configuring encryption and data masking settings, the plugin generates a JAR package, which is then integrated into the project requiring encryption. The ciphertext within the project can be decrypted using this JAR package, while incremental data is encrypted and persisted to the database via the same package. For plugin deployment instructions, refer to the Plugin Deployment.

Download encryption plugin

  1. Logging In to the Database Encryption System using the system administrator sysadmin account.
  2. Select Project Management in the left navigation tree.
  3. View the project list. hover over the project you want to edit to display the download plugin.

    Figure 1 Project management

  4. A pop-up window will prompt you on how to set environment variables. Click Confirm to enter the encryption plugin download page.

    The download path is the browser's default file download path. The page will display the IP address, port, and project ID of the transparent encryption gateway platform. After integrating the download plugin, the plugin will retrieve the encryption/decryption rules configured in the fields from the platform's project based on the above information.

    Figure 2 AKSK configuration guide

  5. Click Confirm to download and save the plugin locally for easy use in your business system.

    Figure 3 Encryption plugin configuration details

    Parameter

    Description

    Encryption Gateway Platform

    Show the IP address and server port of the current encrypted gateway platform.

    Project ID

    The project's unique ID, used for displaying and troubleshooting issues.

    ak

    The system calculates the AppCode based on project information and built-in algorithms, which users must configure as environment variables in the application environment where the plugin is integrated. Here, AK is publicly displayed.

    sk

    The system calculates the AppCode based on project information and built-in algorithms, which users must configure as environment variables in the application environment where the plugin is integrated. While SK is hidden by default; clicking the display button reveals it.

    Risk Warning

    Highlight the relevant risks associated with AKSK and provide recommendation settings.

    The downloaded plugin is a ZIP package (plugins.zip), and the files included in the ZIP package are as shown in Figure 4. In the preceding information, encryption-proxy.jar is the encryption and decryption plug-in package, and bcprov-jdk18on-1.79.jar is the encryption and decryption dependency package.
    Figure 4 List of downloaded files

Plugin Deployment

Unzip the zip archive and copy the two files to the business system service environment. Generally, this is under WEB-INF/lib for web applications. For Spring Boot applications, it's under BOOT-INF/lib, and can also be integrated via POM. If the service is in JAR format, you can use WinRAR to open the JAR file, copy the plugin JAR file to the lib directory, and restart the business system service after deployment.

Figure 5 Adding plugin to application

Plugin Configuration

Adapting the encryption/decryption plugin for your application requires modifying the database connection configuration file, primarily by changing the database driver file and URL. We'll explain how to configure the plugin from the perspectives of configuration files, middleware, application, and data source.

Configuration File

The following examples use YAML, Properties, and XML configuration files to illustrate how to modify configuration files when integrating plugins.

This configuration uses MySQL as an example. The URL configuration varies depending on the database; please refer to the Data Source section for details.

YAML
database:
#driverclass: com.mysql.cj.jdbc.Driver
driverclass: com.pced.engine.spy.MaskingDriver
#url: jdbc:mysql://localhost:3306/mydatabase
url: jdbc:masking:mysql://localhost:3306/mydatabase
username: myuser
password: mypassword
Properties
#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.driver-class-name=com.pced.engine.spy.MaskingDriver #spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase?
useSSL=false&serverTimezone=UTC
spring.datasource.url=jdbc:masking:mysql://localhost:3306/mydatabase? useSSL=false&serverTimezone=UTC
spring.datasource.username=myuser
spring.datasource.password=mypassword
XML
<!-- Configuring Data Sources -->  
<bean id="dataSource"
class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<!-- <property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/> -->
<property name="driverClassName" value="com.pced.engine.spy.MaskingDriver"/>
<!-- <property name="url" value="jdbc:mysql://localhost:3306/mydatabase?useSSL=false&serverTimezone=UTC"/> -->
<property name="url" value="jdbc:masking:mysql://localhost:3306/mydatabase? useSSL=false&serverTimezone=UTC"/>
<property name="username" value="myuser"/>
<property name="password" value="mypassword"/> </bean>

Middleware

The following examples, using WebSphere, Tomcat, and XML configuration files, illustrate how to modify the configuration files when integrating plugins.

WebSphere

  1. Access the WebSphere console, click Resources > JDBC > JDBC Providers on the left side of the menu, and then click the New button on the right side of the menu to create a JDBC driver.

    Figure 6 Websphere - Creating driver information

  2. Create a JDBC provider. Select User-defined for the database type and enter "com.pced.engine.spy.MaskingDriverPoolDataSource" as the implementation class name.

    Figure 7 WebSphere - Selecting driver class

  3. Add the plugin's classpath. This step requires placing the plugin package in the lib directory, typically located at ${product installation path}/AppServer/lib.

    Figure 8 WebSphere - Modifying driver path

  4. Click Finish to complete the creation of the JDBC provider.

    Figure 9 WebSphere - Completing driver creation

  5. Click Resources > JDBC > Data Sources, and then click New on the right side of the menu to create a data source. Note that the node name and server name must be consistent with those used when creating the JDBC provider.

    Figure 10 WebSphere - Selecting a data source

  6. Create a new data source. Both the data source name and the JNDI name should be masking. Click Next.

    Figure 11 WebSphere - Creating a new data source

  7. On the Select JDBC Provider page, click the Select an existing JDBC provider radio button, select the JDBC provider you created earlier, and click Next.

    Figure 12 WebSphere - Selecting driver

  8. Click Next.

    Figure 13 WebSphere - Inputing control class

  9. Select the previously created account and password. If there is none, leave it blank. You can edit and configure it after creating the data source. Click Next.

    Figure 14 WebSphere - Entering alias

  10. Click Finish.

    Figure 15 WebSphere - Browsing configuration information

  11. On the Data Source > Masking > JAAS - J2C > Authentication Data page, configure the account and password by clicking New.

    Figure 16 WebSphere - Selecting a data source

  12. Enter your username and password, then click Confirm.

    Figure 17 WebSphere - Adding authentication information

  13. Configure the URL information for the data source. Edit the data source and click Customize Properties.

    Figure 18 WebSphere - Editing data source

  14. On the Custom Properties page, click New.

    Figure 19 WebSphere - Managing other data sources

  15. On the new page, fill in the database URL information. The URL needs to be entered differently for different databases. Please refer to the Data Source.

    Figure 20 WebSphere - Configuring other data sources

  16. After saving all the information, check if the page displays the following information. If it does, click Save. This is the final saved result.

    Figure 21 WebSphere - Browsing prompts

WebLogic

  1. Access the WebLogic Server management console, click Services > Data Sources, and then click the data source name on the right side of the page to access the data source details page.

    Figure 22 WebLogic - Browsing data sources

  2. On the data source details page, select the Configuration > Connection Pool tab. Change the URL and driver class name in the details page to the following configuration.

    This configuration uses MySQL as an example. The URL configuration varies depending on the database; please refer Data Source.

    Figure 23 WebLogic - Configuration url

Tomcat

Tomcat offers two data source configuration options: local data source configuration and global data source configuration. The two configuration methods are as follows:

  • The path of the local data source file configured for the Tomcat is ${Tomcat installation path}/conf/context.xml. You can modify the configuration file as follows.
    The configuration here uses Oracle as an example. The URL configuration varies depending on the database. Please refer to the Data Source.
    Figure 24 Tomcat - Modifing configuration
  • The global data source file path for Tomcat is ${tomcat installation path}/conf/server.xml. You can modify the configuration file as follows.
    Figure 25 Tomcat - Modifing configuration

    ----End

Application

Typical applications that the plugin is compatible with include FineReport and Kettle applications.

FineReport

  1. Log in to the data decision system, click Management System > Data Connection > Data Connection Management, and click the Edit button on the right side of the page.

    Figure 26 FineReport - Editing data connection

  2. In the data source editing interface, modify the driver information and database url. Note that you should first select the default driver information, and then directly edit the text; you don't need to click the drop-down menu. Click Test Connection to check if the configuration is correct.

    The URL varies according to the database. For details, see Data Source.
    Figure 27 FineReport - Editing data connection

Kettle

  1. In Kettle's main object tree, select Transform > DB Connection, right-click the data source you want to edit, and left-click the Edit button.

    Figure 28 Kettle - Selecting a data source

  2. In the pop-up data source connection editing page, select Generic database as the connection type, Native (JDBC) as the connection method, and edit the custom connection URL and custom driver class name.

    The URL here needs to be entered differently depending on the database. Please refer to the Data Source.

    Figure 29 Kettle - Selecting a data source

Data Source

Modify the database connection configuration file for the program; JDBC configuration file changes:

driver-class-name: com.pced.engine.spy.MaskingDriver

Jdbc-url The configuration differences are as follows:

  • Mysql

    jdbc-url: jdbc:masking:mysql://*****:3306/****

  • Sqlserver

    jdbc-url:jdbc:masking:sqlserver://*****:1433;DatabaseName=database;applicationName=schem ;

  • Dameng

    jdbc-url:jdbc:masking:dm://*****:5237?SCHEMA=myschema

    Where myschema is the database schema.

  • Opengauss

    jdbc-url:jdbc:masking:postgresql://*****:5432/database?currentSchema=myschema

    Where myschema is the database schema.

  • DB2

    jdbc-url:jdbc:masking:db2://*****:50000/test:currentSchema=RY

    Where RY is the database schema.

  • Kingbase

    jdbc-url:jdbc:masking:kingbase8://*****:54321/test?currentSchema= myschema

    Where myschema is the database schema.

  • Oracle

    jdbc-url:jdbc:masking:oracle:thin:@*****:1521/TEST

  • Postgres

    jdbc-url:jdbc:masking:postgresql://*****:54321/wireless?currentSchema=myschema

    Where myschema is the database schema.

  • MariaDB

    jdbc-url: jdbc:masking:mariadb://*****:3306/****

  • Greenplum

    jdbc-url:jdbc:masking:postgresql://*****:5432/database?currentSchema=myschema

    Where myschema is the database schema.