ClassFinal 简介
ClassFinal是一款java class文件安全加密工具,支持直接加密jar包或war包,无需修改任何项目代码,兼容spring-framework;可避免源码泄漏或字节码被反编译。
功能特性
- 无需修改原项目代码,只要把编译好的jar/war包用本工具加密即可。
- 运行加密项目时,无需求修改tomcat,spring等源代码。
- 支持普通jar包、springboot jar包以及普通java web项目编译的war包。
- 支持spring framework、swagger等需要在启动过程中扫描注解或生成字节码的框架。
- 支持maven插件,添加插件后在打包过程中自动加密。
- 支持加密WEB-INF/lib或BOOT-INF/lib下的依赖jar包
环境依赖
JDK 1.8 +
使用步骤
1. 加密命令
java -jar classfinal-fatjar.jar -file yourpaoject.jar -libjars a.jar,b.jar -packages com.yourpackage,com.yourpackage2 -exclude com.yourpackage.Main -pwd 123456 -Y
2.参数说明
-file | 加密的jar/war完整路径 |
-packages | 加密的包名(可为空,多个用","分割) |
-libjars | jar/war包lib下要加密jar文件名(可为空,多个用","分割) |
-cfgfiles | 需要加密的配置文件,一般是classes目录下的yml或properties文件(可为空,多个用","分割) |
-exclude | 排除的类名(可为空,多个用","分割) |
-classpath | 外部依赖的jar目录,例如/tomcat/lib(可为空,多个用","分割) |
-pwd | 加密密码,如果是#号,则使用无密码模式加密 |
-code | 机器码,在绑定的机器生成,加密后只可在此机器上运行 |
-Y | 无需确认,不加此参数会提示确认以上信息 |
结果: 生成 yourpaoject-encrypted.jar,这个就是加密后的jar文件;加密后的文件不可直接执行,需要配置javaagent。
注: 以上示例是直接用参数执行,也可以直接执行 java -jar classfinal-fatjar.jar按照步骤提示输入信息完成加密。
3.插件方式
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> <plugin> <!-- https://gitee.com/roseboy/classfinal --> <groupId>net.roseboy</groupId> <artifactId>classfinal-maven-plugin</artifactId> <version>1.2.1</version> <configuration> <!--加密打包之后pom.xml会被删除,不用担心在jar包里找到此密码--> <password>123456</password> <packages>com.whty.tec</packages> <!-- 需要加密的配置文件多个以 , 分割 --> <cfgfiles>application.yml</cfgfiles> <libjars>tylicense-spring-boot-starter-0.0.1-SNAPSHOT.jar</libjars> </configuration> <executions> <execution> <phase>package</phase> <goals> <goal>classFinal</goal> </goals </execution> </executions> </plugin> </plugins> </build>
- 运行mvn package时会在target下自动加密生成yourpaoject-encrypted.jar。
- maven插件的参数名称与直接运行的参数相同,请参考上节的参数说明。
4. 启动加密后的jar
- 加密后的项目需要设置javaagent来启动项目,项目在启动过程中解密class,完全内存解密,不留下任何解密后的文件。
- 解密功能已经自动加入到 yourpaoject-encrypted.jar中,所以启动时-javaagent与-jar相同,不需要额外的jar包。
- 启动jar项目执行以下命令:java -javaagent:yourpaoject-encrypted.jar -jar yourpaoject-encrypted.jar
5.注意事项
- 本工具使用AES算法加密class文件,密码是保证不被破解的关键,请保存好密码,请勿泄漏。
- 密码一旦忘记,项目不可启动且无法恢复,请牢记密码。
- 本工具加密后,原始的class文件并不会完全被加密,只是方法体被清空,保留方法参数、注解等信息,这是为了兼容spring,swagger等扫描注解的框架;
- 方法体被清空后,反编译者只能看到方法名和注解,看不到方法的具体内容;当class被classloader加载时,真正的方法体会被解密注入。