Spring Boot 2.x系列【27】应用篇之代码混淆

ゝ一纸荒年。 2023-10-09 15:09 16阅读 0赞

> **有道无术，术尚可求，有术无道，止于术。**
> 
> **本系列Spring Boot版本2.7.0**

#### 文章目录 ####

*   *  概述
     *   *  代码混淆
     *  ProGuard
     *   *  使用Maven 插件
         *  直接使用工具混淆

### 概述 ###

#### 代码混淆 ####

`代码混淆(Obfuscated code)`亦称花指令，是将计算机程序的代码，转换成难于阅读和理解的形式的行为。

**比如以下几种方式：**

*  将代码中的各种元素，如**变量，函数，类**的名字改写成无意义的名字。比如改写成单个字母，或是简短的无意义字母组合，甚至改写成`“__”`这样的符号，使得阅读的人无法根据名字猜测其用途。
 *  重写代码中的部分逻辑，将其变成功能上等价，但是更难理解的形式。比如将`for`循环改写成`while`循环，将循环改写成递归，精简中间变量。
 *  打乱代码的格式。比如删除空格，将多行代码挤到一行中，或者将一行代码断成多行等等。

**也会带来一些问题：**

*  被混淆的代码难于理解，因此调试以及除错也变得困难起来。开发人员通常需要保留原始的未混淆的代码用于调试。
 *  对于支持反射的语言，代码混淆有可能与反射发生冲突。
 *  代码混淆并不能真正阻止反向工程，只能增大其难度。
 *  对于对安全性要求很高的场合，仅仅使用代码混淆并不能保证源代码的安全。

由于跨平台的需要，`Java`字节码中包括了很多源代码信息，如变量名、方法名，并且通过这些名称来访问变量和方法，这些符号带有许多语义信息，很容易被反编译成`Java`源代码。为了防止这种现象，我们可以使用`Java混淆器`对`Java`字节码进行混淆。

`混淆`作用不仅仅是保护代码，它也有精简编译后程序大小的作用。由于以上介绍的缩短变量和函数名以及丢失部分信息的原因， 编译后`jar`文件体积大约能减少25% 。

### ProGuard ###

[github地址][github]  
[官网地址][Link 1]

`ProGuard`是一个开源的`Java`类文件压缩、优化、混淆和预验证工具。`ProGuard`可以将JAVA 程序变得更小、更快，并且可以增加代码被反编译的难度。

**主要功能有：**

*  检测并删除未使用的类、字段、方法和属性
 *  优化字节码并删除未使用的指令
 *  混淆使用无意义的短名称重命名的类、字段和方法
 *  预验证信息添加到类中

![在这里插入图片描述][fcd6940e65e44c7e822e698050c0eefb.png]  
**工作原理：**

*  首先读取输入的 jars（或 aars、wars、ears、zip、apks 或目录）
 *  进行压缩、优化、混淆和预验证
 *  将处理后的结果写入一个或多个输出 jar（或 aars、wars、ears、zip、apks 或目录）

#### 使用Maven 插件 ####

官方只提供了`Gradle`插件，`Maven`只有开源的一些实现，还不保证起功能的完整性。。。  
![在这里插入图片描述][d1be3c424f78443f9edb8787441cab70.png]  
首先找一个`Spring Boot`项目，在根目录添加`directory.txt`文件配置混淆字典，用于替换类名、变量名等，默认是单个字母，每行保持唯一性，内容如下：

0000O000000o
    000O00000Oo
    000O00000o0
    000O00000o
    000O00000oO

添加配置项文件`proguard.cfg`放在项目根目录，也就是混淆的各种配置项：

# 添加字典
    -obfuscationdictionary 'directory.txt'
    -classobfuscationdictionary 'directory.txt'
    -packageobfuscationdictionary 'directory.txt'
    
    # 文档 https://www.guardsquare.com/manual/home#entry-points
    
    #指定Java的版本
    -target 1.8
    #proguard会对代码进行优化压缩，他会删除从未使用的类或者类成员变量等
    -dontshrink
    #是否关闭字节码级别的优化，如果不开启则设置如下配置
    -dontoptimize
    #混淆时不生成大小写混合的类名，默认是可以大小写混合
    -dontusemixedcaseclassnames
    # 对于类成员的命名的混淆采取唯一策略
    -useuniqueclassmembernames
    #混淆时不生成大小写混合的类名，默认是可以大小写混合
    -dontusemixedcaseclassnames
    #混淆类名之后，对使用Class.forName('className')之类的地方进行相应替代
    -adaptclassstrings
    #对异常、注解信息予以保留
    -keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
    # 此选项将保存接口中的所有原始名称（不混淆）-->
    -keepnames interface ** {
         *; }
    # 此选项将保存所有软件包中的所有原始接口文件（不进行混淆）
    #-keep interface * extends * { *; }
    #保留参数名，因为控制器，或者Mybatis等接口的参数如果混淆会导致无法接受参数，xml文件找不到参数
    -keepparameternames
    # 保留枚举成员及方法
    -keepclassmembers enum * {
         *; }
    # 不混淆所有类,保存原始定义的注释-
    -keepclassmembers class * {
        
                            @org.springframework.context.annotation.Bean *;
                            @org.springframework.beans.factory.annotation.Autowired *;
                            @org.springframework.beans.factory.annotation.Value *;
                            @org.springframework.stereotype.Service *;
                            @org.springframework.stereotype.Component *;
                            }
    
    #忽略warn消息
    -ignorewarnings
    #忽略note消息
    -dontnote
    #打印配置信息
    -printconfiguration
    #启动类不混淆
    -keep public class cn.herodotus.dante.gateway.GatewayApplication {
        
            public static void main(java.lang.String[]);
        }

添加`Maven` 混淆、打包插件：

<build>
            <plugins>
                
                <plugin>
                    <groupId>com.github.wvengen</groupId>
                    <artifactId>proguard-maven-plugin</artifactId>
                    <version>2.6.0</version>
                    <executions>
                        
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>proguard</goal>
                            </goals>
                        </execution>
                    </executions>
                    <configuration>
                        
                        <injar>${project.build.finalName}.jar</injar>
                        
                        <outjar>${project.build.finalName}.jar</outjar>
                        
                        <obfuscate>true</obfuscate>
                        
                        <proguardInclude>${project.basedir}/proguard.cfg</proguardInclude>
                        
                        <libs>
                            <lib>${java.home}/lib/rt.jar</lib>
                            <lib>${java.home}/lib/jce.jar</lib>
                            <lib>${java.home}/lib/jsse.jar</lib>
                        </libs>
                        
                        <inLibsFilter>!META-INF/**,!META-INF/versions/9/**.class</inLibsFilter>
                        
                        <outputDirectory>${project.basedir}/target</outputDirectory>
                        
                        <options>
                            
                        </options>
                    </configuration>
                </plugin>
                
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>

点击`package`进行打包，成功打包：  
![在这里插入图片描述][ecd62225a3134374bf56009cee742690.png]  
查看JAR 包，发现类名被混淆：  
![在这里插入图片描述][9f5b7c0352f04955850568325e2a0cc8.png]  
将Class 文件复制到`target`目录下查看，代码中也有不少混淆：  
![在这里插入图片描述][6be8f330f78342558e10b09a3c71f827.png]  
启动混淆后的JAR 包，能正常启动：  
![在这里插入图片描述][020d3447279b4323a0dde6f8d38a3a5c.png]

#### 直接使用工具混淆 ####

[下载][Link 2]  
![在这里插入图片描述][cd9f386bf4e6413d9d5604dcc6691f84.png]  
解压并启动：  
![在这里插入图片描述][5e231d8b98734bcba3e94f954960c6d7.png]  
可以在控制台对`JAR`包进行混淆：  
![在这里插入图片描述][183b455164644719b99e7a6cace38ba4.png]

在混淆`Spring Boot`JAR 包时，发现`ProGuard` 要求 jar 文件中类文件的名称直接对应于类的名称，`BOOT-INF/classes`这样的前缀识别不了，无法混淆。。。所以就懒得再试了。

需要解决办法的可以研究下[stackoverflow][]

[github]: https://github.com/Guardsquare/proguard
[Link 1]: https://www.guardsquare.com/manual/home
[fcd6940e65e44c7e822e698050c0eefb.png]: https://img-blog.csdnimg.cn/fcd6940e65e44c7e822e698050c0eefb.png
[d1be3c424f78443f9edb8787441cab70.png]: https://img-blog.csdnimg.cn/d1be3c424f78443f9edb8787441cab70.png
[ecd62225a3134374bf56009cee742690.png]: https://img-blog.csdnimg.cn/ecd62225a3134374bf56009cee742690.png
[9f5b7c0352f04955850568325e2a0cc8.png]: https://img-blog.csdnimg.cn/9f5b7c0352f04955850568325e2a0cc8.png
[6be8f330f78342558e10b09a3c71f827.png]: https://img-blog.csdnimg.cn/6be8f330f78342558e10b09a3c71f827.png
[020d3447279b4323a0dde6f8d38a3a5c.png]: https://img-blog.csdnimg.cn/020d3447279b4323a0dde6f8d38a3a5c.png
[Link 2]: https://github.com/Guardsquare/proguard/releases
[cd9f386bf4e6413d9d5604dcc6691f84.png]: https://img-blog.csdnimg.cn/cd9f386bf4e6413d9d5604dcc6691f84.png
[5e231d8b98734bcba3e94f954960c6d7.png]: https://img-blog.csdnimg.cn/5e231d8b98734bcba3e94f954960c6d7.png
[183b455164644719b99e7a6cace38ba4.png]: https://img-blog.csdnimg.cn/183b455164644719b99e7a6cace38ba4.png
[stackoverflow]: https://stackoverflow.com/questions/48256186/spring-boot-proguard-warning-there-were-184-classes-in-incorrectly-named-files