实现maven管理的Javaweb项目的proguard代码混淆功能

• 在网上找了很多关于代码混淆的例子,最终结合网上知识以及自己的项目实现了代码混淆,实现过程如下:1、在pom.xml文件的<build>   <finalName>as</finalName></build>中加入如下配置:<plugins>   <!--ProGuard混淆插件-->     &n

• 在网上找了很多关于代码混淆的例子,最终结合网上知识以及自己的项目实现了代码混淆,实现过程如下:

  1、在pom.xml文件的

  <build>

      <finalName>as</finalName>

  </build>

  中加入如下配置:

  <plugins>

      <!-- ProGuard混淆插件-->

          <plugin>

              <groupId>com.github.wvengen</groupId>

              <artifactId>proguard-maven-plugin</artifactId>

              <version>2.0.11</version>

              <executions>

                  <execution>

                      <!-- 混淆时刻,这里是打包的时候混淆-->

                      <phase>package</phase>

                      <goals>

                          <!-- 使用插件的什么功能,当然是混淆-->

                          <goal>proguard</goal>

                      </goals>

                  </execution>

              </executions>

              <configuration>

                  <!-- 是否将生成的PG文件安装部署-->

                  <attach>true</attach>

                  <!-- 是否混淆-->

                  <obfuscate>true</obfuscate>

                  <!-- 指定生成文件分类 -->

                  <attachArtifactClassifier>pg</attachArtifactClassifier>

                  <options>

                      <!-- JDK目标版本1.7-->

                      <option>-target 1.7</option>

                      <!-- 不做收缩(删除注释、未被引用代码)-->

                      <option>-dontshrink</option>

                      <!-- 不做优化(变更代码实现逻辑)-->

                      <option>-dontoptimize</option>

                      <!-- 不路过非公用类文件及成员-->

                      <option>-dontskipnonpubliclibraryclasses</option>

                      <option>-dontskipnonpubliclibraryclassmembers</option>

                      <!-- 优化时允许访问并修改有修饰符的类和类的成员 -->

                      <option>-allowaccessmodification</option>

                      <!-- 确定统一的混淆类的成员名称来增加混淆-->

                      <option>-useuniqueclassmembernames</option>

                      <!-- 不混淆所有包名,本人测试混淆后WEB项目问题实在太多,毕竟Spring配置中有大量固定写法的包名-->

                      <option>-keeppackagenames</option>

                      <!-- 不混淆所有特殊的类-->

                      <option>-keepattributesExceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod</option>

                      <!-- 不混淆所有的set/get方法,毕竟项目中使用的部分第三方框架(例如Shiro)会用到大量的set/get映射-->

                      <option>-keepclassmemberspublic class * {void set*(***);*** get*();}</option>

   

                      <!-- com.test.prog.util, util包不混淆的类的属性及方法,实体包 -->

                      <option>-keep classcom.zykj.dbCon.DBConnect{ *; }</option>

   

                      <!-- 不混淆凭证包下的所有类名,但对类中的属性、方法进行混淆,原因是Spring配置中用到了这个类名-->

                      <option>-keep classcom.zykj.util.Tools</option>

                      <option>-keep classcom.zykj.httpClient.HttpDeal</option>

                     

                      <!-- 不混淆job包下的所有类名,且类中的方法也不混淆-->

                      <option>-keep classcom.zykj.controller.** { &lt;methods&gt;; }</option>

                  </options>

                  <outjar>${project.build.finalName}-pg.jar</outjar>

                  <!-- 添加依赖,这里你可以按你的需要修改,这里测试只需要一个JRE的Runtime包就行了 -->

                  <libs>

                      <lib>${java.home}/lib/rt.jar</lib>

                      <lib>${java.home}/lib/jce.jar</lib>   

                      <lib>${java.home}/lib/security/local_policy.jar</lib> 

                      <lib>${java.home}/lib/security/US_export_policy.jar</lib>

                      <lib>${java.home}/lib/ext/sunjce_provider.jar</lib>

                  </libs>

                  <!-- 加载文件的过滤器,就是你的工程目录了-->

                  <inFilter>com/zykj/**</inFilter>

                  <!-- 对什么东西进行加载,这里仅有classes成功,毕竟你也不可能对配置文件及JSP混淆吧-->

                  <injar>classes</injar>

                  <!--<injar>${project.build.finalName}/WEB-INF/classes/</injar> -->

                  <!-- 输出目录-->

                  <outputDirectory>${project.build.directory}</outputDirectory>

              </configuration>

          </plugin>

      </plugins>

      <resources>

          <resource>

              <directory>src/main/resources</directory>

              <includes>

                  <include>**/*.properties</include>

                  <include>**/*.xml</include>

              </includes>

          </resource>

          <resource>

              <directory>src/main/java</directory>

              <excludes>

                  <exclude>**/*.java</exclude>

                  <exclude>**/.svn/*</exclude>

              </excludes>

          </resource>

      </resources>

  2、在myeclipse中右键项目选择Run As-Maven build. . .

  在Goals中填写cleanpackage -DskipTests -X

  点击按钮Run

  3、在项目的target目录下生成如下几个文件:

  其中

  classes-pg.jar 混淆后的classes文件,里面包含完整的项目结构

  proguard_map.txt 混淆内容的映射

  proguard_seed.txt 参与混淆的类 

  4、将classes-pg.jar解压如下:

  其中com文件夹就是混淆后的类文件夹(内容为混淆后的class文件)。

  5、利用myelicpse打包整个项目成war包,用winrar或者好压打开war包,找到WEB-INF\classes下的com文件夹,将解压出来的com文件夹及其内容替换之。

  6、把war放到服务器上运行,生成的class文件就是混淆文件了。

 

仅做记录之用。　　

　　java代码可以反编译，因此有时候要保护自己的知识产权还真得费点心思，一般来说有三个思路：

　　1、将class文件加密，这个是最安全的，但也费事儿，因为要重写classloader来解密class文件；

　　2、使用花指令，使得class文件不能反编译（利用反编译工具漏洞)；安全性一般，还是有花指令**器；

　　3、代码混淆，提高代码阅读成本；简单易操作，一般采用这种或者与其它方式结合；

　　我们项目中用到的即为代码混淆工具ProGuard，相关文章参考：

　　http://blog.****.net/wltj920/article/details/48970869

　　http://blog.****.net/earbao/article/details/51000108

　　ProGuard是一个纯java编写的混淆工具，有客户端跟jar包两种使用方式。可以将程序打包为jar，然后用工具进行混淆，也可以在maven中导入ProGuard的插件，对代码进行混淆。本例中为对普通javaweb项目进行代码混淆。maven配置插件如下：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

<!-- ProGuard混淆插件--> <plugin>    <groupId>com.github.wvengen</groupId>    <artifactId>proguard-maven-plugin</artifactId>    <version>2.0.11</version>    <executions>       <execution>          <!-- 混淆时刻，这里是打包的时候混淆-->          <phase>package</phase>          <goals>             <!-- 使用插件的什么功能，当然是混淆-->             <goal>proguard</goal>          </goals>       </execution>    </executions>    <configuration>       <!-- 是否将生成的PG文件安装部署-->       <attach>true</attach>       <!-- 是否混淆-->       <obfuscate>true</obfuscate>       <!-- 指定生成文件分类 -->       <attachArtifactClassifier>pg</attachArtifactClassifier>       <options>          <!-- JDK目标版本1.8-->          <option>-target 1.8</option>          <!-- 不做收缩（删除注释、未被引用代码）-->          <option>-dontshrink</option>          <!-- 不做优化（变更代码实现逻辑）-->          <option>-dontoptimize</option>          <!-- 不路过非公用类文件及成员-->          <option>-dontskipnonpubliclibraryclasses</option>          <option>-dontskipnonpubliclibraryclassmembers</option>          <!--不用大小写混合类名机制-->          <option>-dontusemixedcaseclassnames</option>            <!-- 优化时允许访问并修改有修饰符的类和类的成员 -->          <option>-allowaccessmodification</option>          <!-- 确定统一的混淆类的成员名称来增加混淆-->          <option>-useuniqueclassmembernames</option>          <!-- 不混淆所有包名-->          <!--<option>-keeppackagenames</option>-->            <!-- 需要保持的属性：异常，注解等-->          <option>-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod</option>          <!-- 不混淆所有的set/get方法->          <!--<option>-keepclassmembers public class * {void set*(***);*** get*();}</option>-->            <!-- 不混淆包下的所有类名，且类中的方法也不混淆-->          <option>-keep class com.xxx.xxx.bboss.SystemConfig { <methods>; }</option>          <option>-keep class com.xxx.xxx.framework.** { *; }</option>          <option>-keep class com.xxx.xxx.xxx.controller.** { <methods>; }</option>          <option>-keep class com.xxx.xxx.xxx.dao.** { <methods>; }</option>          <option>-keep class com.xxx.xxx.xxx.exception { <methods>; }</option>          <option>-keep class com.xxx.xxx.xxx.model.** { <methods>; }</option>         </options>       <!--class 混淆后输出的jar包-->       <outjar>classes-autotest.jar</outjar>       <!-- 添加依赖，这里你可以按你的需要修改，这里测试只需要一个JRE的Runtime包就行了 -->       <libs>          <lib>${java.home}/lib/rt.jar</lib>       </libs>       <!-- 对什么东西进行加载，这里仅有classes成功，毕竟你也不可能对配置文件及JSP混淆吧-->       <injar>classes</injar>       <!-- 输出目录-->       <outputDirectory>${project.build.directory}</outputDirectory>    </configuration> </plugin>

　　运行 mvn clean package -DskipTests

　　混淆后结果如图所示：

　　classes-pg.jar为混淆后的classes文件，里边包含完整的项目结构

　　proguard_map.txt混淆内容映射

　　proguard_seed.txt参与混淆的类

　　混淆后反编译代码如下：

 

　　可以看到，部分包名跟类名已经被改为了简单字母，不再具有业务含义，而且变量名也进行了修改，增加了阅读代码难度。

　　运行服务，项目正常运行。

　　需要注意的问题：

　　1、因为有时候会配置不保持包名或类名，因此一些相关配置文件的内容需要改变，好在ProGuard不是随机生成类名，而是先按照原名称对相同包下类进行排序，混淆后的类名称依次为a.class，b.class，c.class.....

那么问题来了，当包中超过26个类时，默认命名为A.class，B.class，C.class，在某些操作系统下，会不区分class文件名称的大小写，会导致错误(水平所限，未深入探究跟类加载相关);因此

　　<!--不用大小写混合类名机制-->

　　<option>-dontusemixedcaseclassnames</option>

　　配置极为关键，该配置会在超过26个类文件时，命名为aa.class，ab.class，ac.class，而不是原来的大写类名，从而避免错误。

　　2、打包部署问题。该配置文件打包出来的war中classes文件仍然为正常代码，需要手动解压，将classes-pg.jar中classes替换进去，在工程化管理的情况下，可以在jenkins中配置脚本，自动将混淆后的classes替换进war包：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

#更改war包classes为混淆包的内容 cd /root/.jenkins/workspace/mytest_master/target jar -xvf classes-pg.jar rm -rf mytest mkdir mytest mv mytest.war mytest cd mytest/ jar -xvf mytest.war rm -rf WEB-INF/classes/com/ cd ../   cp -rf com mytest/WEB-INF/classes/ cd mytest jar -cvfM0 mytest.war ./ mv mytest.war ../

这样jenkins打出的就是混淆后的war包了，可以直接交给客户使用。