Protect Spring Boot App

GUI Tool

Execute protector4j-ui[.exe] in the tool's directory, you will see the interface below

Login

If you have got the license, you can click the login button on the top-right corner and input your account information. Although, without the license, you still can test this tool.

Choose app type

Click the "Spring Boot Application" button on the app types page.

Choose jars to protect

Choose the jars files to protect, you can add single or multi jar files.

Options

Protect all classes

if this option is selected, all the classes will be encrypted during the task

Protect the specified classes

If this option is selected, you can choose which classes to encrypt in the next step

Protect inner jars

If this option is checked, the classes in the inner jars will be encrypted too.

Choose classes to protect

If you selected "Protect the specified classes" in the previous step, you will see this page. On this page, you can choose some key classes to encrypt.

Output options

On this page, you can specify the Java version, the output folder and the target platforms. After this is done, click the "Next" button on the bottom, it will start the encryption process.

Encryption process

It will take some time to finish the encryption process. After it is done, you can check the result in the output folder.

Check the result

After the encryption process complete, please go to the output folder to check the result. The encrypted jars and the custom java runtime are in there.

Run the encrypted app

You should use our custom java runtime to run the encrypted app, go the output folder and execute:

jre/bin/java -jar xxx.jar

Every encryption task will request a new and unique key. The files that are been encrypted in different task can not be used together.

CLI Tool

The configuration of task file

Please find task.spring-boot.yml in the task-templates folder, copy and modify a new one.

email: ''
password: ''
jarsPath: []
protectAll: false
protectInnerJars: false
classesToProtect: []
outputFolder: ''
tempFolder: ''
javaVersion: ''
targetPlatforms: []

The account information

If you have purchased this tool, you would have got your account information including the email address and the password for the license. Please type them in the appropriate fields, the value of the password field should be the md5 value of the password, not the password itself. or you can leave the email and the password fields empty, just try this tool.

email: ''
password: '[md5-of-password]'

Specify the jars and the classes need to be encrypted.

jarsPath

The jarsPath field is an array, which you could specify one or multi jar files that need to be processed in the encryption work.

jarsPath: ['jar-path1','jar-path2',...]

or

jarsPath:
- 'jar-path1'
- 'jar-path2'

protectAll

If this value is true, all the classes in the jar will be encrypted.

protectInnerJars

If this value is true, the classes in the inner jars will be encrypted too.

classesToProtect

In this field, you can specify the classes that need to be encrypted. It can be a full class name, or wildcard- case ones, just like:

classesToProtect:
- 'vlinx.test.TestClass1'
- 'vlinx.test.pack1.*'
- 'vlinx.test.pack1.**'

* means all the classes in the package, but exclude the classes in the subpackage

** means all the classes in the package including the classes in the subpackage.

If the protectAll is true, this field will be ignored.

protectInnerJars

if the protectInnerJars value is true, the classes in the inner jars will also be encrypted according to the classToProtectList, if the protectAll is true, all the classes in all inner jars will be encrypted.

javaVersion

The java versions supported now are Java 8 and Java 11, you can type "java-8" for Java 8 and type "java-11" for Java 11

tempFolder

The temp folder for the files generated during the encryption process, after the task completed, the files in the temp folder will be cleaned.

outputFolder

The encrypted app and the custom Java runtime will be placed into the output folder.

targetPlatforms

This field is an array too, the available values are [linux64, win64, mac, linux32, win32], you can set one or multi target platforms according to the requirement.

On windows, currently only supports win64 and win32 as the target platforms.

targetPlatforms:
- 'linux64'
- 'win64'
- 'mac'
- 'linux32'
- 'win32'

Execute the encryption process

Go the tool's directory and execute the command below to runthe encryption process

protector4j -t spring-boot -f path-of-task-file

-t task type

-f task file

protector4j --help` to see the detail arguments.

Check the result

After the encryption process, please go to the output folder to check the result. The encrypted jars and the custom java runtime are in there.

Run the encrypted app

You should use our custom java runtime to run the encrypted app, go the output folder and execute the command below

jre/bin/java -jar xxx.jar

Every encryption task will request a new and unique key. The files that are been encrypted in different task can not be used together.