文章目录
- proguard-maven-plugin 代码混淆
- 官网地址
- 入门
- 小结
- ClassFinal 代码加密
- 介绍
- Gitee
- 项目模块说明
- 功能特性
- 环境依赖
- 使用说明
- 下载
- 加密
- maven插件方式
- 无密码模式
- 机器绑定
- 启动加密后的jar
- tomcat下运行加密后的war
- 版本说明
- 协议声明
- classfinal实战
- 工程
- pom
- 编译打包
- 配置文件
- 运行
- 无密码启动
- 带密码启动
- 机器绑定只允许加密的项目在特定的机器上运行
proguard-maven-plugin 代码混淆
官网地址
https://github.com/wvengen/proguard-maven-plugin
https://wvengen.github.io/proguard-maven-plugin/
入门
以下是使用proguard-maven-plugin插件的一些示例配置和用法:
- 基本配置示例:
<build>
<plugins>
<plugin>
<groupId>com.github.wvengen</groupId>
<artifactId>proguard-maven-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>proguard</goal>
</goals>
</execution>
</executions>
<configuration>
<options>
<option>-allowaccessmodification</option>
<option>-keep public class * extends java.applet.Applet { *; }</option>
</options>
<libs>
<lib>${java.home}/lib/rt.jar</lib>
</libs>
</configuration>
</plugin>
</plugins>
</build>
这个示例配置会在打包过程中执行ProGuard,并应用指定的选项和库。
- 使用自定义配置文件:
<build>
<plugins>
<plugin>
<groupId>com.github.wvengen</groupId>
<artifactId>proguard-maven-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>proguard</goal>
</goals>
</execution>
</executions>
<configuration>
<obfuscate>true</obfuscate>
<injar>${project.build.finalName}.jar</injar>
<outjar>${project.build.finalName}-small.jar</outjar>
<outputDirectory>${project.build.directory}</outputDirectory>
<proguardInclude>${basedir}/proguard.conf</proguardInclude>
<libs>
<lib>${java.home}/lib/rt.jar</lib>
<lib>${java.home}/lib/jsse.jar</lib>
</libs>
</configuration>
</plugin>
</plugins>
</build>
这个示例配置会使用自定义的ProGuard配置文件,并将混淆后的JAR文件输出到指定目录。
- 复杂Applet创建示例:
<build>
<plugins>
<plugin>
<groupId>com.github.wvengen</groupId>
<artifactId>proguard-maven-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>proguard</goal>
</goals>
</execution>
</executions>
<configuration>
<proguardInclude>${basedir}/proguard.conf</proguardInclude>
<assembly>
<inclusions>
<!-- 添加已经以不同选项预处理的JAR文件 -->
<inclusion>
<groupId>org.microemu</groupId>
<artifactId>microemu-cldc</artifactId>
<classifier>4applet</classifier>
<library>true</library>
</inclusion>
<!-- 过滤掉一些类 -->
<inclusion>
<groupId>org.microemu</groupId>
<artifactId>microemu-javase</artifactId>
<filter>!org/microemu/app/classloader/**</filter>
</inclusion>
</inclusions>
</assembly>
<exclusions>
<exclusion>
<groupId>org.microemu</groupId>
<artifactId>microemu-midp</artifactId>
</exclusion>
</exclusions>
<libs>
<lib>${java.home}/lib/rt.jar</lib>
<lib>${java.home}/lib/jsse.jar</lib>
</libs>
</configuration>
</plugin>
</plugins>
</build>
这个示例配置演示了一个复杂的Applet创建过程,包括依赖配置和ProGuard选项。
小结
采用proguard-maven-plugin插件, 在单模块中此方案还算简单,但是现在项目一般都是多模块,一个模块依赖多个公共模块。那么使用此方案就比较麻烦,配置复杂,文档难懂,各模块之间的调用在是否混淆时极其容易出错。
ClassFinal 代码加密
介绍
ClassFinal是一款java class文件安全加密工具,支持直接加密jar包或war包,无需修改任何项目代码,兼容spring-framework;可避免源码泄漏或字节码被反编译。
Gitee
https://gitee.com/roseboy/classfinal
项目模块说明
- classfinal-core: ClassFinal的核心模块,几乎所有加密的代码都在这里;
- classfinal-fatjar: ClassFinal打包成独立运行的jar包;
- classfinal-maven-plugin: ClassFinal加密的maven插件;
功能特性
- 无需修改原项目代码,只要把编译好的jar/war包用本工具加密即可。
- 运行加密项目时,无需求修改tomcat,spring等源代码。
- 支持普通jar包、springboot jar包以及普通java web项目编译的war包。
- 支持spring framework、swagger等需要在启动过程中扫描注解或生成字节码的框架。
- 支持maven插件,添加插件后在打包过程中自动加密。
- 支持加密WEB-INF/lib或BOOT-INF/lib下的依赖jar包。
- 支持绑定机器,项目加密后只能在特定机器运行。
- 支持加密springboot的配置文件。
环境依赖
JDK 1.8 +
使用说明
下载
点此下载
加密
执行以下命令
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
参数说明
-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按照步骤提示输入信息完成加密。
maven插件方式
在要加密的项目pom.xml中加入以下插件配置,目前最新版本是:1.2.1。
<plugin>
<!-- https://gitee.com/roseboy/classfinal -->
<groupId>net.roseboy</groupId>
<artifactId>classfinal-maven-plugin</artifactId>
<version>${classfinal.version}</version>
<configuration>
<password>000000</password><!--加密打包之后pom.xml会被删除,不用担心在jar包里找到此密码-->
<packages>com.yourpackage,com.yourpackage2</packages>
<cfgfiles>application.yml</cfgfiles>
<excludes>org.spring</excludes>
<libjars>a.jar,b.jar</libjars>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>classFinal</goal>
</goals>
</execution>
</executions>
</plugin>
运行mvn package时会在target下自动加密生成yourpaoject-encrypted.jar。
maven插件的参数名称与直接运行的参数相同,请参考上节的参数说明。
无密码模式
加密时-pwd参数设为#,启动时可不用输入密码;
如果是war包,启动时指定参数 -nopwd,跳过输密码过程。
机器绑定
机器绑定只允许加密的项目在特定的机器上运行;
在需要绑定的机器上执行以下命令,生成机器码
java -jar classfinal-fatjar.jar -C
加密时用-code指定机器码。机器绑定可同时支持机器码+密码的方式加密。
启动加密后的jar
加密后的项目需要设置javaagent来启动,项目在启动过程中解密class,完全内存解密,不留下任何解密后的文件。
解密功能已经自动加入到 yourpaoject-encrypted.jar中,所以启动时-javaagent与-jar相同,不需要额外的jar包。
启动jar项目执行以下命令:
java -javaagent:yourpaoject-encrypted.jar='-pwd 0000000' -jar yourpaoject-encrypted.jar
//参数说明
// -pwd 加密项目的密码
// -pwdname 环境变量中密码的名字
或者不加pwd参数直接启动,启动后在控制台里输入密码,推荐使用这种方式:
java -javaagent:yourpaoject-encrypted.jar -jar yourpaoject-encrypted.jar
使用nohup命令启动时,如果系统支持gui,会弹出输入密码的界面,如果是纯命令行下,不支持gui,则需要在同级目录下的classfinal.txt或yourpaoject-encrypted.classfinal.txt中写入密码,项目读取到密码后会清空此文件。
密码读取顺序已经改为:参数获取密码||环境变量获取密码||密码文件获取密码||控制台输入密码||GUI输入密码||退出
tomcat下运行加密后的war
将加密后的war放在tomcat/webapps下,
tomcat/bin/catalina 增加以下配置:
//linux下 catalina.sh
CATALINA_OPTS="$CATALINA_OPTS -javaagent:classfinal-fatjar.jar='-pwd 0000000'";
export CATALINA_OPTS;
//win下catalina.bat
set JAVA_OPTS="-javaagent:classfinal-fatjar.jar='-pwd 000000'"
//参数说明
// -pwd 加密项目的密码
// -nopwd 无密码加密时启动加上此参数,跳过输密码过程
// -pwdname 环境变量中密码的名字
本工具使用AES算法加密class文件,密码是保证不被破解的关键,请保存好密码,请勿泄漏。
密码一旦忘记,项目不可启动且无法恢复,请牢记密码。
本工具加密后,原始的class文件并不会完全被加密,只是方法体被清空,保留方法参数、注解等信息,这是为了兼容spring,swagger等扫描注解的框架;
方法体被清空后,反编译者只能看到方法名和注解,看不到方法的具体内容;当class被classloader加载时,真正的方法体会被解密注入。
为了保证项目在运行时的安全,启动jvm时请加参数: -XX:+DisableAttachMechanism 。
版本说明
- v1.2.1 bug修复
- v1.2.0 packages、libjars、cfgfiles、exclude 参数增加通配符功能
- v1.1.7 支持加密springboot的配置文件;增加环境变量中读取密码
- v1.1.6 增加机器绑定功能
- v1.1.5 增加无密码加密方式,启动无需输密码,但是并不安全
- v1.1.4 纯命令行下运行jar时,从配置文件中读取密码,读取后清空文件
- v1.1.3 加入输入密码的弹框
- v1.1.2 修复windows下加密后不能启动的问题
- v1.1.1 启动jar时在控制台输入密码,无需将密码放在参数中
- v1.1.0 加密jar包时将解密代码加入加密后的jar包,无需使用多余的jar文件
- v1.0.0 第一个正式版发布
协议声明
Apache-2.0
classfinal实战
工程
pom
放到spring-boot-maven-plugin插件后面,否则不起作用
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>2.7.18</version>
</plugin>
<plugin>
<!--
1. 加密后,方法体被清空,保留方法参数、注解等信息.主要兼容swagger文档注解扫描
2. 方法体被清空后,反编译只能看到方法名和注解,看不到方法体的具体内容
3. 加密后的项目需要设置javaagent来启动,启动过程中解密class,完全内存解密,不留下任何解密后的文件
4. 启动加密后的jar,生成xxx-encrypted.jar,这个就是加密后的jar文件,加密后不可直接执行
5. 无密码启动方式,java -javaagent:xxx-encrypted.jar -jar xxx-encrypted.jar
6. 有密码启动方式,java -javaagent:xxx-encrypted.jar='-pwd= 密码' -jar xxx-encrypted.jar
-->
<groupId>net.roseboy</groupId>
<artifactId>classfinal-maven-plugin</artifactId>
<version>1.2.1</version>
<configuration>
<password>#</password><!-- #表示启动时不需要密码,事实上对于代码混淆来说,这个密码没什么用,它只是一个启动密码 -->
<excludes>org.spring</excludes>
<packages>${groupId}</packages><!-- 加密的包名,多个包用逗号分开 -->
<cfgfiles>application.properties,application.yml,application-dev.yml</cfgfiles><!-- 加密的配置文件,多个包用逗号分开 -->
<libjars>hutool-all.jar</libjars> <!-- jar包lib下面要加密的jar依赖文件,多个包用逗号分开 -->
<!-- <code>xxxx</code> -- 指定机器启动,机器码 -->
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>classFinal</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
编译打包
配置文件
<cfgfiles>application.properties,application.yml,application-dev.yml</cfgfiles><!-- 加密的配置文件,多个包用逗号分开 -->
加密后内容为空 。
启动包加密之后,方法体被清空,保留方法参数、注解等信息.主要兼容swagger文档注解扫描
反编译只能看到方法名和注解,看不到方法体的具体内容
启动过程中解密class,完全内存解密,不留下任何解密后的文件
运行
无密码启动
java -javaagent:boot-async-0.0.1-SNAPSHOT-encrypted.jar -jar boot-async-0.0.1-SNAPSHOT-encrypted.jar
带密码启动
重新编译新的jar后,
java -javaagent:boot-async-0.0.1-SNAPSHOT-encrypted.jar='-pwd=123456' -jar boot-async-0.0.1-SNAPSHOT-encrypted.jar
貌似要输入密码。。。。
java -javaagent:boot-async-0.0.1-SNAPSHOT-encrypted.jar -jar boot-async-0.0.1-SNAPSHOT-encrypted.jar
不加pwd参数直接启动,启动后在控制台里输入密码,推荐使用这种方式
机器绑定只允许加密的项目在特定的机器上运行
在需要绑定的机器上执行以下命令,生成机器码
java -jar classfinal-fatjar.jar -C
加密时用-code指定机器码。机器绑定可同时支持机器码+密码的方式加密。
下载到classfinal-fatjar-1.2.1.jar
依赖,在当前依赖下cmd执行java -jar classfinal-fatjar-1.2.1.jar -C
命令,会自动生成一串机器码.
将此生成好的机器码,放到maven插件中的code里面即可。这样,打包好的项目只能在生成机器码的机器运行,其他机器则启动不了项目