Updated on 2026-09-24 GMT+08:00

Downloading the Encryption Plugin

The encryption plugin is a Jar file generated and downloaded from the Database Encryption System Management Console, after the encryption settings for data have been configured via the Management Console. Once downloaded, this Jar file is deployed on the business system; upon integration, it can intercept database read/write requests and automatically perform real-time encryption and decryption of sensitive fields, enabling the business system to seamlessly support the encrypted database without requiring any modification to its existing code – thereby achieving transparent and seamless data security processing. The plugin is not universally applicable and can only be used within the specific project (business system) in which it was deployed.

Procedure

  1. Log in to the database encryption system using the system administrator (sysadmin) account.
  2. Click Project Management in the left navigation tree; the system will then display a list of all projects, as shown in Figure 1.

    Figure 1 Project management

  3. View the project list; hover your mouse over the project that requires a plugin integration, then click Download Plugin, as shown in Figure 2.

    Figure 2 Downloading the plugin

  4. A pop-up window will display the method for configuring environment variables; as shown in Figure 3, click Confirm to proceed to the encryption plugin download interface.

    Figure 3 AKSK configuration prompt

  5. The page will display the IP address, port, and project ID of the Transparent Encryption Gateway Platform; click Generate to generate the AppCode required by the plugin. After downloading the plugin via the Application Integration, the plugin will retrieve the encryption/decryption rules configured for the fields from the platform's project using the above information, as shown in Figure 4.

    Figure 4 Plugin information & download-1
    • The AK and SK displayed on the page are shown only once and cannot be retrieved later. After generating them, please copy them and save them to a file for future use.
    • For security reasons, SK is displayed with an asterisk (*); SK needs to save its plaintext. You can click the icon on the right side of the text box to display the plaintext, then copy and save it.

  6. Click and select the General plugin menu item to save the plugin locally for use within the business system; see Figure 5 for details. The parameter descriptions for the plugin download page are provided in Table 1. Generating and downloading the plugin may take some time; please wait for 1–2 minutes. The plugin will be downloaded to the default file download location specified by your browser.

    Figure 5 Plugin information & download-2
    Table 1 Download plugin page parameter guide

    Parameter

    Description

    Encryption Gateway Platform

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

    Project ID

    The unique identifier for this project, used for displaying and troubleshooting issues.

    AK

    The system calculates the AppCode based on project information and built-in service algorithms; the user must then configure this value as an environment variable within the application environment where the plugin is integrated. The AK is displayed.

    SK

    The system calculates the AppCode based on project information and built-in service algorithms; the user must then configure this value as an environment variable within the application environment where the plugin is integrated. By default, this setting is hidden; clicking on it will display it.

    The downloaded plugin is a ZIP archive (plugins.zip); the files contained within this archive are shown in Figure 6.
    Figure 6 Downloaded files list

    The `encryption-proxy.jar` file is the encryption/decryption plugin package, while `bcprov-jdk18on-1.79.jar` is the encryption/decryption dependency package. To protect intellectual property rights, the encrypted plugin package has been encrypted; the `sjt_agent.jar` file is the package used to decrypt this encrypted Jar file.