一、混淆简介
Android中的“混淆”可以分为两部分,一部分是 Java 代码的优化与混淆,依靠 proguard 混淆器来实现;另一部分是资源压缩,将移除项目及依赖的库中未被使用的资源(资源压缩严格意义上跟混淆没啥关系,但一般我们都会放一起讲)。
1. 代码压缩
代码混淆是包含了代码压缩、优化、混淆等一系列行为的过程。如上图所示,混淆过程会有如下几个功能:
- 压缩。移除无效的类、类成员、方法、属性等;
- 优化。分析和优化方法的二进制代码;根据proguard-android-optimize.txt中的描述,优化可能会造成一些潜在风险,不能保证在所有版本的Dalvik上都正常运行。
- 混淆。把类名、属性名、方法名替换为简短且无意义的名称;
- 预校验。添加预校验信息。这个预校验是作用在Java平台上的,Android平台上不需要这项功能,去掉之后还可以加快混淆速度。
这四个流程默认开启。
-dontoptimize
、-dontpreverify
(当然,默认的 proguard-android.txt
2. 资源压缩
build.grade
文件中,将 shrinkResources
属性设置为 true
。需要注意的是,只有在用minifyEnabled true
开启了代码压缩后,资源压缩才会生效。
资源压缩包含了“合并资源”和“移除资源”两个流程。
这一流程不受shrinkResources
属性控制,也无法被禁止,src/main/res/
- 不同的构建类型(debug、release等等)
- 不同的构建渠道
- 项目依赖的第三方库
合并资源时按照如下优先级顺序:
依赖 -> main -> 渠道 -> 构建类型
main
文件夹和不同渠道中,gradle 会选择保留渠道中的资源。src/main/res/
和 src/main/res/
,则 gradle 无法完成资源合并,这时会报资源合并错误。
“移除资源”流程则见名知意,需要注意的是,类似代码,混淆资源移除也可以定义哪些资源需要被保留,这点在下文给出。
二、自定义混淆规则
在上文“混淆配置”中有这样一行代码
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
tools/proguard/
文件夹中的 proguard-android.txt
的内容以及默认放置于模块根目录的 proguard-rules.pro
1. 常见混淆命令:
- optimizationpasses
- dontoptimize
- dontusemixedcaseclassnames
- dontskipnonpubliclibraryclasses
- dontpreverify
- dontwarn
- verbose
- optimizations
- keep
- keepnames
- keepclassmembers
- keepclassmembernames
- keepclasseswithmembers
- keepclasseswithmembernames
需要特别介绍的是与保持相关元素不参与混淆的规则相关的几种命令:
命令 | 作用 |
-keep | 防止类和成员被移除或者被重命名 |
-keepnames | 防止类和成员被重命名 |
-keepclassmembers | 防止成员被移除或者被重命名 |
-keepnames | 防止成员被重命名 |
-keepclasseswithmembers | 拥有该成员的类和成员被移除或者被重命名 |
-keepclasseswithmembernames | 拥有该成员的类和成员被重命名 |
2. 保持元素不参与混淆的规则
形如:
[保持命令] [类] {
[成员]
}
“类”代表类相关的限定条件,它将最终定位到某些符合该限定条件的类。它的内容可以使用:
- 具体的类
public
- 、
protected
- 、
private
- )
*
- ,匹配任意长度字符,但不含包名分隔符(.)
**
- ,匹配任意长度字符,并且包含包名分隔符(.)
extends
- ,即可以指定类的基类
implement
- ,匹配实现了某接口的类
- $,内部类
“成员”代表类成员相关的限定条件,它将最终定位到某些符合该限定条件的类成员。它的内容可以使用:
- <init>,匹配所有构造器
- <ifield>,匹配所有字段
- *,匹配所有字段和方法(在类内部使用)
*
- ,匹配任意长度字符,但不含包名分隔符(.)
**
- ,匹配任意长度字符,并且包含包名分隔符(.)
***
- ,匹配任意参数类型
…
- ,匹配任意长度的任意类型参数。比如void test(…)就能匹配任意
void test(String a)
- 或者是
void test(int a, String b)
public
- 、
protected
- 、
private
- )
name.huihui.test
包下所有继承Activity
的public
类及其构造函数都保持住,可以这样写:
-keep public class name.huihui.test.** extends Android.app.Activity {
<init>
}
3. 常用的自定义混淆规则
- 不混淆某个类
-keep public class name.huihui.example.Test { *; }
- 不混淆某个包所有的类
-keep class name.huihui.test.** { *; }
- 不混淆某个类的子类
-keep public class * extends name.huihui.example.Test { *; }
- 不混淆所有类名中包含了“model”的类及其成员
-keep public class **.*model*.** {*;}
- 不混淆某个接口的实现
-keep class * implements name.huihui.example.TestInterface { *; }
- 不混淆某个类的构造方法
-keepclassmembers class name.huihui.example.Test {
public <init>();
}
- 不混淆某个类的特定的方法
-keepclassmembers class name.huihui.example.Test {
public void test(java.lang.String);
}
三、自定义资源保持规则
1. keep.xml
shrinkResources true
开启资源压缩后,所有未被使用的资源默认被移除。假如你需要定义哪些资源必须被保留,在 res/raw/
路径下创建一个 xml 文件,例如 keep.xml
。
通过一些属性的设置可以实现定义资源保持的需求,可配置的属性有:
tools:keep
tools:discard
tools:shrinkMode
Resources.getIdentifier()
String name = String.format("img_%1d", angle + 1);
res = getResources().getIdentifier(name, "drawable", getPackageName());
tools:shrinkMode
为 strict
以上就是自定义资源保持规则相关的配置,举个例子:
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
tools:keep="@layout/l_used*_c,@layout/l_used_a,@layout/l_used_b*"
tools:discard="@layout/unused2"
tools:shrinkMode="strict"/>
2. 移除替代资源
strings.xml
,多分辨率支持的 layout.xml
resConfig
android {
defaultConfig {
...
resConfigs "en", "fr"
}
}
其他未显式声明的语言资源将被移除。
四、解出混淆栈
1. 自定义混淆规则
app module
下默认生成了项目的自定义混淆规则文件 proguard-rules.pro
,多方调研后,一份适用于大部分项目的混淆规则最佳实践如下:
#指定压缩级别
-optimizationpasses 5
#不跳过非公共的库的类成员
-dontskipnonpubliclibraryclassmembers
#混淆时采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
#把混淆类中的方法名也混淆了
-useuniqueclassmembernames
#优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification
#将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile
#保留行号
-keepattributes SourceFile,LineNumberTable
#保持所有实现 Serializable 接口的类成员
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
#Fragment不需要在AndroidManifest.xml中注册,需要额外保护下
-keep public class * extends android.support.v4.app.Fragment
-keep public class * extends android.app.Fragment
# 保持测试相关的代码
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**
真正通用的、需要添加的就是上面这些,除此之外,需要每个项目根据自身的需求添加一些混淆规则:
- 第三方库所需的混淆规则。正规的第三方库一般都会在接入文档中写好所需混淆规则,使用时注意添加。
model
- 包下的话,可以添加类似这样的代码把所有实体类都保持住:
-keep public class **.*Model*.** {*;}
JNI
- 中调用的类。
WebView
- 中
JavaScript
- 调用的方法
Layout
- 布局使用的
View
- 构造函数、
android:onClick
- 等。
2. 检查混淆结果
混淆过的包必须进行检查,避免因混淆引入的bug。
<module-name>/build/outputs/mapping/release/
dump.txt
- 描述APK文件中所有类的内部结构
mapping.txt
- 提供混淆前后类、方法、类成员等的对照表
seeds.txt
- 列出没有被混淆的类和成员
usage.txt
- 列出被移除的代码
seeds.txt
文件检查未被混淆的类和成员中是否已包含所有期望保留的,再根据 usage.txt
另一方面,需要从测试方面检查。将混淆过的包进行全方面测试,检查是否有 bug 产生。
3. 解出混淆栈
混淆后的类、方法名等等难以阅读,这固然会增加逆向工程的难度,但对追踪线上 crash 也造成了阻碍。我们拿到 crash 的堆栈信息后会发现很难定位,这时需要将混淆反解。
<sdk-root>/tools/proguard/
路径下有附带的的反解工具(Window 系统为 proguardgui.bat
,Mac 或 Linux 系统为 proguardgui.sh
)。proguardgui.bat
后,可以看到左侧的一行菜单。点击 ReTrace
,选择该混淆包对应的 mapping 文件(混淆后在 <module-name>/build/outputs/mapping/release/
路径下会生成 mapping.txt
文件,它的作用是提供混淆前后类、方法、类成员等的对照表),再将 crash 的 stack trace
黏贴进输入框中,点击右下角的 ReTrace
retrace
retrace.bat|retrace.sh [-verbose] mapping.txt [<stacktrace_file>]
例如:
retrace.bat -verbose mapping.txt obfuscated_trace.txt
注意事项:
AndroidManifest.xml
proguard-android.txt
已经存在一些默认混淆规则,没必要在 proguard-rules.pro