关于代码混淆，看这篇就够了

叁歲伎倆 2024-03-27 16:49 122阅读 0赞

## 代码混淆 ##

### 一.基本概念 ###

java的bytecode很容易通过JAD等反编译工具还原出源代码。这样势必不满足安全的定义。如何一定程度上保护需要防止被反编译的源代码呢？**混淆**（obfuscate）技术。注意：用obfuscate防盗版是根本不可能，连汇编这种东西都能被\*\*掉，而java代码基本上等同于开源的同义词。用obfuscate只是为了增加反编译的难度，保护源代码的知识产权。混淆包照常运行，没有任何问题。可以使用反编译工具如jd-gui查看混淆后的包，验证混淆效果。

### 二.混淆技术 ###

#### 名称混淆 name obfuscode ####

将有意义的类，字段、方法名称更改为无意义的字符串。生成的新名称越 短，字节代码越小。在名称混淆的字节代码中，包，类，字段和方法名称已重命名，并且永远不能恢复原始名称。

#### 流混淆 Flow Obfuscation ####

用于if, switch, while,for等关键字，对字节码进行细微的修改，模糊控制流，而不改变代码在运行时的行为。通常情况下，选择和循环等逻辑构造会被更改，因此它们不再具有直接等效的Java源代码。流模糊的字节码通常强制反编译器将一系列标签和非法的goto语句插入到它们生成的源代码中。源代码有时会因为反编译错误而变得更加模糊。

#### 其他 ####

*  异常混淆 Exception Obfuscation
 *  字符串加密混淆 String Encryption
 *  引用混淆 Reference Obfuscation

### 三.常用工具 ###

#### 1.proguard ####

proguard是一个免费的 Java类文件的压缩，优化，混肴器。它删除没有用的类，字段，方法与属性。使字节码最大程度地优化，使用简短且无意义的名字来重命名类、字段和方法  
官网地址：[www.guardsquare.com/en/products…][www.guardsquare.com_en_products]

#### 2.yGuard ####

yGuard是一款免费的Java混淆器（非开源），它有Java和.NET两个版本。yGuard 完全免费，基于 Ant 任务运行，提供高可配置的混淆规则。  
官网地址：[www.yworks.com/products/yg…][www.yworks.com_products_yg]

#### 3.allatori ####

第二代Java混淆器。所谓第二代混淆器，不仅仅能进行字段混淆，还能实现流混淆。  
命名混淆，流混淆，调试信息混淆，字符串编码，以及水印技术。对于教育和非商业项目来说这个混淆器是免费的。支持war和jar格式，支持对需要混淆代码的应用程序添加有效日期。  
官网地址：[www.allatori.com/][www.allatori.com]

#### 4.总结 ####

推荐使用 proguard ：开源， 使用简单 ，文档丰富完善。

### 四.工具对比 ###

<table> 
 <thead> 
  <tr> 
   <th>工具</th> 
   <th>官网地址</th> 
   <th>官方文档</th> 
   <th>开源免费</th> 
   <th>名称混淆</th> 
   <th>流混淆</th> 
   <th>maven支持</th> 
   <th>功能</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>proguard</td> 
   <td><a href="https://link.juejin.cn?target=https%3A%2F%2Fwww.guardsquare.com%2Fproguard" title="www.guardsquare.com/proguard" rel="nofollow">www.guardsquare.com/proguard</a></td> 
   <td><a href="https://link.juejin.cn?target=https%3A%2F%2Fwww.guardsquare.com%2Fmanual%2Fhome" title="www.guardsquare.com/manual/home" rel="nofollow">www.guardsquare.com/manual/home</a></td> 
   <td>√</td> 
   <td>√</td> 
   <td>✕</td> 
   <td>√</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>yGuard</td> 
   <td><a href="https://link.juejin.cn?target=https%3A%2F%2Fwww.yworks.com%2Fproducts%2Fyguard" title="www.yworks.com/products/yg…" rel="nofollow">www.yworks.com/products/yg…</a></td> 
   <td><a href="https://link.juejin.cn?target=https%3A%2F%2Fyworks.github.io%2FyGuard%2F" title="yworks.github.io/yGuard/" rel="nofollow">yworks.github.io/yGuard/</a></td> 
   <td>√</td> 
   <td>√</td> 
   <td>✕</td> 
   <td>√</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>allatori</td> 
   <td><a href="https://link.juejin.cn?target=https%3A%2F%2Fallatori.com%2F" title="allatori.com/" rel="nofollow">allatori.com/</a></td> 
   <td></td> 
   <td>✕（免费用于教育和非商业项目）</td> 
   <td>√</td> 
   <td>√</td> 
   <td>√</td> 
   <td>减小包大小；混淆代码；添加水印</td> 
  </tr> 
 </tbody> 
</table>

### 五.详细内容 ###

#### 1.yGuard（[yworks.github.io/yGuard/][yworks.github.io_yGuard]） ####

*  易于设置：yGuard 是一个 Ant 任务！作为 Ant 任务，yGuard 可以无缝集成到您在 Ant、Maven 和 Gradle 等众多构建系统中的部署过程中
 *  高级收缩：yGuard 通过依赖分析提供精细的代码收缩功能。
 *  可配置/安全代码：yGuard 提供高度可配置的名称混淆，可保护您的知识产权免受逆向工程。
 *  开源：yGuard 是完全开源的！与昂贵的商业产品相反，yGuard 是并且永远都是免费的。
 *  Java 兼容性：要运行 yGuard 软件，您需要 JDK 1.7.x 或更高版本以及 Ant 1.5.x 或更高版本（它可能与任一软件的早期版本兼容，但尚未经过测试）。  
    yGuard 与所有已发布的 Java 版本（最高 Java 17）兼容。但是，根据使用的版本，功能可能会略有不同。该文档包含[不同版本支持的功能的详细说明][Link 1]。如果您打算将 yGuard 与 Java 以外的东西一起使用，还有一个关于[3rd 方 JVM 支持的部分。][3rd _ JVM]

#### ProGuard ####

是一个开源的 Java 类文件收缩器、优化器、混淆器和预验证器。因此，ProGuard 处理的应用程序和库更小、更快，并且在一定程度上可以抵御逆向工程。

*  ***收缩步骤***检测并删除未使用的类、字段、方法和属性。
 *  **优化器** ***步骤***优化字节码并删除未使用的指令。
 *  ***混淆步骤***使用简短无意义的名称重命名剩余的类、字段和方法。
 *  最后的***预验证步骤***将预验证信息添加到类中，这是 Java Micro Edition 和 Java 6 及更高版本所必需的。

## yGuard ##

### 1.maven引用方式 ###

<build>
            <plugins>
                <plugin>
                    
                    <artifactId>maven-antrun-plugin</artifactId>
                    <dependencies>
                        <dependency>
                            <groupId>com.yworks</groupId>
                            <artifactId>yguard</artifactId>
                            <version>3.1.0</version>
                        </dependency>
                    </dependencies>
                    <executions>
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>run</goal>
                            </goals>
                            <configuration>
                                <tasks>
                                    <property refid="maven.compile.classpath" name="mvn.classpath"/>
                                    
                                    <taskdef name="yguard"
                        classname="com.yworks.yguard.YGuardTask"/>
                                    
                                    <yguard>
                                        
                                    </yguard>
                                    
                                </tasks>
                            </configuration>
    
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    复制代码

### 2.yguard配置解析 ###

#### 写在前面 ####

1.  yguard共分为两大任务配置：

1.  1.  `rename` 混淆名称 ：主要用于修改类名，属性名，方法名以及参数名等。
    2.  `shrink` 收缩代码 ： 主要用于从多个入口点中删除所有无法访问的类、字段和方法。

1.  `keep` keep是`rename`和`shrink`的子元素，用于指定从父级`rename`或`shrink`任务中排除的元素。

#### 注意事项 ####

1.  `注意事项1` ：**如果项目需要shrink, shrink最好是配置在rename之前**。即在进行代码混淆之前，先进行代码压缩。 因为压缩代码需要指定压缩的根代码。  
    举个例子：比如制定main方法： 。如果先混淆，DplDbtransferApplication类名被修改的话（比如为A.class），该配置将会无效，所有代码都会被 shrink 删除，因为已经找不到DplDbtransferApplication这个类了（类名被修改）。
2.  其他配置请参考官方文档。

#### 配置说明 ####

基础配置

<yguard>
        
        <inoutpair 
        in="${project.build.directory}/${project.build.finalName}.${project.packaging}" 
    	out="${project.build.directory}/${project.build.finalName}.${project.packaging}" />     
    	
    	<externalclasses>
    		
    	</externalclasses>
    	
    	
    	<attribute name="SourceFile, LineNumberTable, LocalVariableTable">
      		<patternset>
        		<include name="com.ewa.pipe.**"/>
      		</patternset>	
    	</attribute>
    	
    	
    	<shrink logfile="${project.build.directory}/yshrink.log.xml" createStubs="true">
    		
            <keep>			
                <method name="void main(java.lang.String[])" class="${mainclass}" />
            </keep>
        </shrink>
        
        
        <rename 
            mainclass="com.ewa.pipe.dbtransfer.dpl.DplDbtransferApplication"
            logfile="${project.build.directory}/yguard.log.xml"
            conservemanifest = "false"
            replaceClassNameStrings="true"
            scramble = "false"
            annotationClass="com.ewa.pipe.dbtransfer.dpl.Test"
        	>   
            	
            	<keep>
                
            	</keep>	
    		    
    	       	<property name="error-checking" value="pedantic"/>
    			
    			
    			 
    	       	<property name="naming-scheme" value="small"/>	
        </rename>
     </yguard>
    复制代码

keep配置说明

class元素

`class`用于在rename和shrink过程中排除某些类，字段和方法。其是keep的子元素。以下是配置说明（- 表示会被收缩，即被删除 ）：

<table> 
 <thead> 
  <tr> 
   <th>可见性（是否被收缩）</th> 
   <th><code>public</code></th> 
   <th><code>protected</code></th> 
   <th><code>friendly</code></th> 
   <th><code>private</code></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>none</code></td> 
   <td>-</td> 
   <td>-</td> 
   <td>-</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>public</code></td> 
   <td>*</td> 
   <td>-</td> 
   <td>-</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>protected</code></td> 
   <td>*</td> 
   <td>*</td> 
   <td>-</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>friendly</code></td> 
   <td>*</td> 
   <td>*</td> 
   <td>*</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>private</code></td> 
   <td>*</td> 
   <td>*</td> 
   <td>*</td> 
   <td>*</td> 
  </tr> 
 </tbody> 
</table>

**属性说明**

1.  `name` 指定要保留的类名。 在shrink中，只会保留类名称，类中的属性和方法都会被删除掉。
2.  `classes` 保持类的可见性 ：其值是上述：`none` , `public` , `protected` , `friendly` , `private` 。默认为none
3.  `methods` 保留方法的可见性 ， 值同classes的描述。默认为none
4.  `fields` 保留属性的可见性 ， 值同classes的描述。默认为none
5.  `extends` 保留对继承了该类的可见性 。1.在shrink中凡是继承了该类的子类都不会被删除。 2.在rename中凡是继承了该类的子类都不会被修改名称。
6.  `implements` 保留对实现该接口的可见性 。1.在shrink中凡是实现该接口的类都不会被删除。 2.在rename中凡是实现该接口的类都不会被修改名称。

**注意事项**

1.  以上属性可以单独使用，一可以混合使用。其 extends/implements 可以和classes， methods，fields混合使用。参考列2说明。

列1:

<shrink logfile="${project.build.directory}/yshrink.log.xml">
           <keep>
                
                <class name="com.arm.code.mix.base.NameTest"/>
    			
           		<class classes="public" methods="public" fields="public"/>
    			
    			<class extends="com.arm.code.mix.base.BaseClass"/>
           </keep>
        </shrink>
    复制代码

列2:

<shrink logfile="${project.build.directory}/yshrink.log.xml">
           <keep>
                
                <class name="com.arm.code.mix.base.NameTest" methods="private" fields="private"/>
    			
    			<class extends="com.arm.code.mix.base.BaseClass" methods="private" fields="private"/>
           </keep>
        </shrink>
    复制代码

列3:

一下举列几个模式集的列子，模式集可以参考ant。
    
    
    <class>
      <patternset>
        <include name="com.mycompany.**.*Bean"/>
        <exclude name="com.mycompany.secretpackage.*"/>
        <exclude name="com.mycompany.myapp.SecretBean"/>
    	
    	<exclude name="org.w3c.sax?.**.*$$*"/> 
      </patternset>
    </class>
    复制代码

method

`method` 用于在rename和shrink过程中排除方法。其是keep的子元素。以下是配置说明（- 表示会被收缩，即被删除 ）：

<method class="com.mycompany.myapp.MyClass"
      name="void main(java.lang.String[])"/>
    <method class="com.mycompany.myapp.MyClass"
      name="int foo(double[][], java.lang.Object)"/>
    <method name="void writeObject(java.io.ObjectOutputStream)">
      <patternset>
        <include name="com.mycompany.myapp.data.*"/>
      </patternset>
    </method>
    <method name="void readObject(java.io.ObjectInputStream)">
      <patternset>
        <include name="com.mycompany.myapp.data.*"/>
      </patternset>
    </method>
    复制代码

field

`field` 您可以按名称指定应从收缩或名称混淆中要保留的字段

<field class="com.mycompany.myapp.MyClass" name="field"/>
    <field name="serialVersionUID">
      <patternset>
        <include name="com.mycompany.myapp.data.*"/>
      </patternset>
    </field>
    复制代码

package

`package` 用于从重命名过程中排除某些包的名称。**它不能用于收缩（shrink）过程** 。这对类、方法或字段名称没有影响。

<package>
          <patternset>
    		
            <include name="com.mycompany.myapp.*"/>
    		
    		<include name="com.mycompany.myapp.**"/>
          </patternset>
        </package>
    复制代码

### 3.几种情况下的使用方式 ###

#### springboot项目 ####

**1.注意事项**

1.  yguard插件执行要放在 spring boot打包项目之前，因为反置的话，会造成jar中的springboot的启动相关类被混淆，而造成启动项目失败。

**2.项目使用失败的问题收集总结**

1.  *本地打包之后启动项目失败：由于是本地idea将jdk设置成jdk17了，导致打包失败。 设置为jdk8后成功启动。*
2.  项目使用mybaties plus，项目里只有一个接口：public interface TimePullLogMapper extends BaseMapper\{\} , 造成混淆后打包报错：spring至少一个bean实现。后面加上： 后正常。==
3.  service的接口和实现都要暴露，不然spring的注入和nacos的服务发现都会存在问题。

**3.配置模版**

<keep>
                                                
                                                <package>
                                                    <patternset>
                                                        <include name="com.arm.oceansearch.**"/>
                                                    </patternset>
                                                </package>
                                                
                                                <class implements="com.arm.boot.core.base.BaseMapper"/>
                                                
                                                <class implements="com.arm.oceansearch.entity.BaseEntity"/>
                                                
                                                <class>
                                                    <patternset>
                                                        <include name="com.arm.oceansearch.controller.*"/>
                                                    </patternset>
                                                </class>
                                                
                                                <class>
                                                    <patternset>
                                                        <include name="com.arm.oceansearch.service.**"/>
                                                    </patternset>
                                                </class>
                                                
                                                <method name="void main(java.lang.String[])"
                                                        class="com.arm.oceansearch.OceanSearchApplication"/>
                                            </keep>
    复制代码

### 简介 ###

ProGuard 是一个开源的 Java 类文件收缩器、优化器、混淆器和预验证器。因此，ProGuard 处理的应用程序和库更小、更快，并且在一定程度上可以抵御逆向工程。

### 对反射的处理 ###

反射和内省对于任何代码的自动处理都存在特殊的问题。在 ProGuard 中，代码中动态创建或调用（即按名称）的类或类成员也必须指定为入口点。例如，`Class.forName()`构造可以在运行时引用任何类。通常不可能计算必须保留哪些类（使用它们的原始名称），因为类名可能是从配置文件中读取的，例如。因此，您必须在 ProGuard 配置中指定它们，同样简单`-keep`选项

*  `Class.forName("SomeClass")`
 *  `SomeClass.class`
 *  `SomeClass.class.getField("someField")`
 *  `SomeClass.class.getDeclaredField("someField")`
 *  `SomeClass.class.getMethod("someMethod", null)`
 *  `SomeClass.class.getMethod("someMethod", new Class[] { A.class,... })`
 *  `SomeClass.class.getDeclaredMethod("someMethod", null)`
 *  `SomeClass.class.getDeclaredMethod("someMethod", new Class[] { A.class,... })`
 *  `AtomicIntegerFieldUpdater.newUpdater(SomeClass.class, "someField")`
 *  `AtomicLongFieldUpdater.newUpdater(SomeClass.class, "someField")`
 *  `AtomicReferenceFieldUpdater.newUpdater(SomeClass.class, SomeType.class, "someField")`

### 支持 ###

1.  可单独使用。首先，下载一个[ProGuard 版本][ProGuard]或者[构建 ProGuard][ProGuard 1]从源头。然后可以通过调用目录中的脚本直接从命令行执行 ProGuard `bin`：  
    linux/mac：bin/proguard.sh -injars path/to/my-application.jar \\ -outjars path/to/obfuscated-application.jar \\ -libraryjars path/to/java/home/lib/rt.jar  
    windows：bin\\proguard.bat -injars path/to/my-applicati^ -outjars path/to/obfuscated-application.jar ^ -libraryjars path/to/java/home/lib/rt.jar
2.  Gradle 模式
3.  ant模式
4.  Maven模式：（没有正式提供 maven 集成，也无法提供支持，但有可用的解决方案，但 Guardsquare 不保证它们提供的功能。）来源实现：  
    [github.com/wvengen/pro…][github.com_wvengen_pro]  
    [github.com/dingxin/pro…][github.com_dingxin_pro]

### 错误解析 ###

1.  \[proguard\] Error: The input doesn't contain any classes. Did you specify the proper '-injars' options?

处理：<inFilter>com/ewa/pipe/**</inFilter>， inFilter标签设置为包路径地址，把‘.’换成‘/’。
    
    injar ： 指定target中的一个目标地址：这里指定编译后的 classes文件夹。  inFilter 指定的是 classes的内部的文件夹（package）地址。
    
                        <inFilter>com/arm/code/**</inFilter>
                        
                        <injar>classes</injar>
    复制代码

以下是一个例子说明，如果你想更多的有用信息，请查看文档（[www.guardsquare.com/manual/conf…][www.guardsquare.com_manual_conf]）

<configuration>
                        
                        <attach>false</attach>
                        
                        <obfuscate>true</obfuscate>
                        
                        
                        
                        <inFilter>com/arm/code/**</inFilter>
                        
                        <injar>classes</injar>
                        
                        <outputDirectory>${project.build.directory}</outputDirectory>
                        <outjar>${project.build.finalName}.${project.packaging}</outjar>
                        <options>
                            
                            <option>-target 1.8</option>
                            
                            <option>-dontshrink</option>
                            
                            <option>-dontoptimize</option>
                            
                            <option>-dontskipnonpubliclibraryclasses</option>
                            <option>-dontskipnonpubliclibraryclassmembers</option>
                            
                            <option>-allowaccessmodification</option>
                            
                            <option>-useuniqueclassmembernames</option>
                            
                            <option>-keeppackagenames</option>
                            
                            <option>-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod</option>
                            
                            <option>-keepclassmembers public class * {void set*(***);*** get*();}</option>
                            
                            <option>-keep class com.arm.code.mix.base.SpringBoot{ <methods>; }</option>
                            
                            
                            
                            
                            
                            
    
                            
                            
                            
                            
                            
                            
                            
                        </options>
    
                        
                        <libs>
                            <lib>${java.home}/lib/rt.jar</lib>
                            <lib>${java.home}/lib/jce.jar</lib>
                            
                            
                            <lib>${java.home}/lib/ext/sunjce_provider.jar</lib>
                        </libs>
                    </configuration>

作者：阿Qoder  
链接：https://juejin.cn/post/7198809411161686071

[www.guardsquare.com_en_products]: https://link.juejin.cn?target=https%3A%2F%2Fwww.guardsquare.com%2Fen%2Fproducts%2Fproguard
[www.yworks.com_products_yg]: https://link.juejin.cn?target=https%3A%2F%2Fwww.yworks.com%2Fproducts%2Fyguard
[www.allatori.com]: https://link.juejin.cn?target=http%3A%2F%2Fwww.allatori.com%2F
[yworks.github.io_yGuard]: https://link.juejin.cn?target=https%3A%2F%2Fyworks.github.io%2FyGuard%2F
[Link 1]: https://link.juejin.cn?target=https%3A%2F%2Fyworks.github.io%2FyGuard%2Fcompatibility%2F
[3rd _ JVM]: https://link.juejin.cn?target=https%3A%2F%2Fyworks.github.io%2FyGuard%2Fcompatibility%2F%23compatibility-to-3rd-party-jvm
[ProGuard]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2FGuardsquare%2Fproguard%2Freleases
[ProGuard 1]: https://link.juejin.cn?target=https%3A%2F%2Fwww.guardsquare.com%2Fmanual%2Fbuilding
[github.com_wvengen_pro]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fwvengen%2Fproguard-maven-plugin
[github.com_dingxin_pro]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fdingxin%2Fproguard-maven-plugin
[www.guardsquare.com_manual_conf]: https://link.juejin.cn?target=https%3A%2F%2Fwww.guardsquare.com%2Fmanual%2Fconfiguration%2Fusage