Android混淆详解

2019-12-27 本文已影响0人 taoyyyy

1.混淆的作用

利用Proguard或者R8工具，对代码进行重命名，并删掉没有被引用的类、字段或者方法。对无用资源进行删除。

2.混淆的用法

2.1 如何开启混淆

android {
        buildTypes {
            release {
                minifyEnabled true
                shrinkResources true
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            }
        }
    }

只有在启用混淆的前提下开启资源压缩才会有效！
getDefaultProguardFile('proguard-android.txt') 方法可从 Android SDK tools/proguard/ 文件夹获取默认的 ProGuard规则文件，表示 Android 系统为我们提供的默认混淆规则文件。
proguard-rules.pro文件用于添加自定义 ProGuard 规则。默认情况下，该文件位于模块根目录。
我们一般在打 release 包时才启用混淆，因为混淆会增加额外的编译时间，所以不建议在 debug 模式下启用。

2.2 proguard与R8

proguard是用于java和android项目的混淆工具。
Android Gradle插件3.4.0或更高版本时，R8和Proguard 相比，R8 可以更快地缩减代码，同时改善输出大小，R8 默认处于启用状态，你可将以下代码添加到项目的。gradle.properties 文件以停用 R8：

android.enableR8=false

2.3 自定义混淆

2.3.1 自定义要保持的代码

2.3.1.1 常用ProGuard规则

proguard中一共有三组六个keep关键字，很多人搞不清楚它们的区别，这里我们通过一个表格来直观地看下：
[图片上传失败...(image-554618-1577426814253)]

除此之外，proguard中的通配符也比较让人难懂，proguard-android.txt中就使用到了很多通配符，我们来看一下它们之间的区别：
[图片上传失败...(image-a3de12-1577426814253)]

关闭压缩
-dontshrink
关闭混淆
-dontobfuscate
保持指定包下的类名，不包括子包下的类名
-keep class com.xy.myapp*
保持指定包下的类名，包括子包下的类名
-keep class com.xy.myapp**
保持指定包下的类名以及类里面的内容
-keep class com.xy.myapp.* {*;}
保持所有继承于指定类的类
-keep public class * extends android.app.Activity

如果我们要保留一个类中的内部类不被混淆则需要用$符号，如下例子表示保持MyClass内部类JavaScriptInterface中的所有public内容。

-keepclassmembers class com.xy.myapp.MyClass$JavaScriptInterface { public *; }

保持指定类的所有方法
-keep class com.xy.myapp.MyClass { public <methods>; }

保持指定类的所有字段
-keep class com.xy.myapp.MyClass { public <fields>; }
保持指定类的所有构造器
-keep class com.xy.myapp.MyClass { public <init>; }
保持用指定参数作为形参的方法
-keep class com.xy.myapp.MyClass { public <methods>(java.lang.String); }

类文件除了定义类，字段，方法外，还为它们附加了一些属性，例如注解，异常，行号等，优化操作会删除不必要的属性，使用-keepattributes可以保留指定的属性
-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
使指定的类不输出警告信息
-dontwarn com.squareup.okhttp.**

2.3.1.2 keep注解

2.3.2 自定义要保持的资源

资源压缩包含了“合并资源”和“移除资源”两个流程。“合并资源”流程中，名称相同的资源被视为重复资源会被合并。需要注意的是，这一流程不受shrinkResources属性控制，也无法被禁止， gradle 必然会做这项工作。
当我们开启了资源压缩之后，系统会默认替我们移除所有未使用的资源，假如我们需要保留某些特定的资源，可以在我们项目中创建一个被 <resources> 标记的 XML 文件（如 res/raw/keep.xml），并在 tools:keep 属性中指定每个要保留的资源，在 tools:discard 属性中指定每个要舍弃的资源。这两个属性都接受逗号分隔的资源名称列表。同样，我们可以使用字符 * 作为通配符。

<?xml version="1.0" encoding="utf-8"?><resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/activity_video*,@layout/dialog_update_v2"
    tools:discard="@layout/unused_layout,@drawable/unused_selector" />

2.3.3 移除替代资源

一些替代资源，例如多语言支持的 strings.xml，多分辨率支持的 layout.xml 等，在我们不需要使用又不想删除掉时，可以使用资源压缩将它们移除。我们使用 resConfig 属性来指定需要支持的属性，例如

  android {
      defaultConfig {
          ...
          resConfigs "en", "fr"
      }
  }

3.混淆的规则

3.1必须保持的代码

proguard-android.txt中的默认混淆规则：

-keepattributes *Annotation* 表示对注解中的参数进行保留。
不混淆任何包含native方法的类的类名以及native方法名。

-keepclassmembers public class * extends android.view.View {
   void set*(***);
   *** get*();
}

不混淆任何一个View中的setXxx()和getXxx()方法，因为属性动画需要有相应的setter和getter的方法实现，混淆了就无法工作了。

-keepclassmembers public class * extends android.view.View {
   void set*(***);
   *** get*();
}

表示不混淆Activity中参数是View的方法，因为有这样一种用法，在XML中配置android:onClick="buttonClick"属性，当用户点击该按钮时就会调用Activity中的buttonClick(View view)方法，如果这个方法被混淆的话就找不到了。

-keepclassmembers class * extends android.app.Activity {
   public void *(android.view.View);
}

不混淆枚举中的values()和valueOf()方法。因为枚举类在编译后会生成一个继承自Enum的类，枚举类型最后转换成类中的static final属性，并多出了values()和valueOf()两个方法。混淆之后，这两个方法会被重命名。

-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

不混淆Parcelable实现类中的CREATOR字段。反序列化的时候，底层会反射获取静态的CREATOR字段，再调用createFromParcel()恢复数据。

-keepclassmembers class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator CREATOR;
}

不混淆R文件中的所有静态字段，我们都知道R文件是通过字段来记录每个资源的id的，字段名要是被混淆了，id也就找不着了。

-keepclassmembers class **.R$* {
    public static <fields>;
}

注解。

-keepattributes *Annotation*
-keep class * extends java.lang.annotation.Annotation {*;}

其他的混淆点：

AndroidManifest.xml引用的四大组件。
反射用到的类。
WebView中JavaScript调用的java接口方法不被混淆。
Layout文件引用的自定义View。
不要混淆第三方库。
Gson使用到的实体类。因为Gson会反射获取与json同名的字段。

3.2 输出文件

启用R8或ProGuard构建项目后会在模块下的build\outputs\mapping\release文件夹下输出下列文件：

dump.txt：说明 APK 中所有类文件的内部结构。
mapping.txt：提供原始与混淆过的类、方法和字段名称之间的转换。
seeds.txt：列出未进行混淆的类和成员。
usage.txt：列出从 APK 移除的代码。

3.3 组件化中的混淆文件合并

主模块的混淆开关配置会直接影响到子模块，也就是说如果你的主模块开启的混淆，就算你的子模块关闭混淆开关，最终子模块还是会被混淆的；
主模块的混淆配置会影响到子模块，即主模块和子模块同时开启了混淆，主模块的proguard-rules.pro配置生效，子模块的不生效。

image.png

consumerProguardFiles作用:

proguard.txt会被打包进aar中
此配置只对aar进行混淆。
此配置只对库文件有效，对应用程序无效。

4.如何应对混淆

4.1mapping映射表+retrace脚本恢复stacktrace

4.2 如何应对代码混淆

找到混淆时生成的mapping文件
jadx反混淆功能
借助jeb工具的重命名功能+自己分析