鸿蒙6.0应用开发——代码混淆
文章目录
- 鸿蒙6.0应用开发——代码混淆
-
- 概述
- 混淆开启
- 混淆配置能力
-
- 编译选项
- 混淆配置
- 混淆规则合并策略
- 查看混淆结果
概述
代码混淆技术可以增加代码的复杂性和模糊性，从而提高攻击者分析代码的难度。代码混淆有以下几个方面的作用：
针对工程源码的混淆提高破解难度，缩短类和成员名称，减小应用大小。
混淆开启
从DevEco Studio版本4.0 Beta1开始，hvigor插件提供代码混淆功能。开启混淆的条件如下：
-
工程为Stage模型
-
在Release编译模式下
-
模块build-profile.json5文件中开启混淆配置
"arkOptions": {
"obfuscation": {
"ruleOptions": {
"enable": true,
// …
}
}
},
enable默认为false，默认不开启代码混淆功能。
满足开启混淆的条件后，选择目标模块，点击Build -> Make Module开始编译。
如果工程或模块是Static Library，则该工程或模块是一个HAR。
构建字节码HAR时有以下三种方式：
图1 DevEco Studio选择release编译模式
图2 DevEco Studio指定模块编译
混淆配置能力
编译选项
若按照上述编译流程开启代码混淆，在DevEco Studio 5.0.3.600之前的版本，默认仅混淆参数名和局部变量名。从DevEco Studio 5.0.3.600版本起，默认启用四项推荐的混淆选项：-enable-property-obfuscation、-enable-toplevel-obfuscation、-enable-filename-obfuscation和-enable-export-obfuscation。开发者可以根据需要进一步修改混淆配置。
如果在流水线开启混淆并使用release构建模式，在编译参数加上 -p buildMode=release -p debuggable=false。
混淆配置
在每个模块下都能找到build-profile.json5文件，如下图所示。可以在此文件中配置是否开启混淆及混淆配置文件。
图3 编译配置文件 
新建工程时，每个模块下都有obfuscation-rules.txt文件，用于配置混淆。
图4 混淆配置文件 
在上图中，obfuscation-rules.txt文件中添加了-enable-property-obfuscation和-enable-toplevel-obfuscation开关，表示已启用属性混淆和顶层作用域名称混淆。
DevEco Studio混淆现有选项及功能描述如下：
| 混淆选项 | -disable-obfuscation | 关闭混淆 |
| -enable-property-obfuscation | 属性混淆 | |
| -enable-toplevel-obfuscation | 顶层作用域名称混淆 | |
| -enable-filename-obfuscation | 文件名混淆 | |
| -enable-export-obfuscation | export导出名称与属性混淆 | |
| -compact | 代码压缩 | |
| -remove-log | 删除console.*方法 | |
| -print-namecache filepath | 指定路径输出namecache.json文件及内容 | |
| -apply-namecache filepath | 复用指定的名称缓存文件 | |
| -remove-comments | 删除注释 | |
| 保留选项 | -keep-property-name | 保留属性名 |
| -keep-global-name | 保留顶层作用域和导出元素的名称 | |
| -keep-file-name | 保留指定的文件/文件夹的名称 | |
| -keep-dts | 读取指定.d.ts文件中的名称作为白名单 | |
| -keep-comments | 保留编译生成的声明文件中class, function, namespace, enum, struct, interface, module, type及属性上方的JsDoc注释 | |
| -keep | 保留指定相对路径中的所有名称（例如变量名、类名、属性名等） | |
| 通配符 | 名称类和路径类的保留选项支持通配符 |
混淆选项具体的使用方法和样例代码可以参考代码混淆。
混淆优化建议
开发人员混淆工程时，发现缓存文件或SDK中的文件中存在大量未混淆的源码名称。原因包括以下两类：
- – 混淆选项开启较少；开启-enable-property-obfuscation、-enable-toplevel-obfuscation、-enable-export-obfuscation、-enable-filename-obfuscation选项。
- – 源码名称与系统白名单、语言白名单重名；添加后缀避开白名单。
混淆规则合并策略
在编译一个模块时，生效的混淆规则是当前编译模块混淆规则和依赖模块混淆规则的合并结果。具体规则请参考：混淆规则合并策略。
查看混淆结果
开发人员在编译模块的build目录中可找到编译和混淆生成的缓存文件、名称映射表及系统API白名单文件。
-
源码编译及混淆缓存文件目录：build/[…]/release/模块名
-
混淆名称映射表及系统API白名单目录：build/[…]/release/obfuscation
- – 名称映射表文件：nameCache.json，记录源码名称映射。
- – 系统API白名单文件：systemApiCache.json，记录SDK接口与属性名称。
图5 DevEco Studio编译产物与缓存文件
