Help Center/ Database Security Service/ User Guide/ Database Encryption/ Series 2/ System Administrator Operation Guide/ Application-plugin Management/ Downloading the Plugin
Updated on 2026-09-24 GMT+08:00
View PDF
Share

Downloading the Plugin

When the database encryption system is managed using the plugin pattern, the system automatically generates a deployable plugin based on the encryption configuration. This plugin is then deployed to the business system upon generation and download, enabling seamless, transparent encryption and decryption functionality.

After completing the encryption and data masking configuration in the Management Console, you can download a plugin generated by the system – this plugin is a JAR file. Integrate this JAR file into the specific business system that requires encryption; thereafter, the data reading and writing operations within that business system can be automatically encrypted or decrypted using this plugin.

The system offers a plugin download feature at numerous locations.

Procedure

  1. Logging In to the Database Encryption System using the system administrator (sysadmin) account .
  2. Select Project Management from the left navigation tree.
  3. View the project list; hover your mouse over the desired project and click plug-in, as shown in Figure 1.

    Figure 1 Project management download plugin

  4. A pop-up window will display the method for configuring environment variables; click Confirm (as shown in Figure 2) to access the encryption plugin download interface.

    Figure 2 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 Application Integration, the plugin will retrieve the encryption/decryption rules configured for the fields from the corresponding project on this platform using the above information, as shown in Figure 3.

    Figure 3 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 store 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 button to save the plugin locally for use within the business system; see Figure 4 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 4 Plugin information and 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 is then required to 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 is then required to configure this value as an environment variable within the application environment where the plugin is integrated.

    SK is hidden by default; click to display it.

The downloaded plugin is a ZIP archive (plugins.zip); the files contained within this archive are shown in Figure 5.
Figure 5 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; sjt_agent.jar is the tool used to decrypt this encrypted JAR file.

Parent Topic: Application-plugin Management