Orca.so

未经允许禁止转载

一、写这篇文章的原因

在平日开发中，我们时常是需要保存一些字符串，而这些字符串比较重要，我们可以通过一些途径进行保存

（1）通过网络分发动态的密码，以及对应的加密的字符串，在一定时间内密码有效。
（2）密码本地存储在一些地方，如SP，数据库，MMKV，动态链接库等等

本文就基于第二种方案中的动态链接库去进行开发，即我们俗称的So库，由于不存在百分百解不开的加密方式，都是时间长和短的问题，我们要增加的是解密的时间成本，而且考虑到开发时候的方便以及性能问题，我们都采用多种结合，例如网路+本地秘钥双重校验，或者动态分发加密关键信息再组合等等。

二、Gradle Plugin开发

1、建一个Module

2、Grdlde基本配置

假设我们的Module名字是plugin,那么在Project根目录的中,修改引入方法

//include(":plguin") 改成下面
includeBuild("plguin")

本项目基于kotlin开发的所以需要把build.gradle修改为build.gradle.kts文件
大致的配置如下:

buildscript {
    repositories {
        jcenter()
        google()
    }
    dependencies {
        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21")
    }
}

dependencies {
    compileOnly(gradleApi())
    compileOnly("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21")
    compileOnly("com.android.tools.build:gradle:4.0.1")
    implementation("com.squareup:javapoet:1.13.0") //用于生产JAVA代码
}

gradlePlugin {
    plugins {
        create(Plugin的名字，自己定义) {
            id = "自己定义独立Id"
            implementationClass = "对应的Plugin的路径，即包名.类名"
        }
    }
}

其中“org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21” 可以修改为 “kotlin-dsl”
主要是为了导入Kotlin开发Gradle Plugin的基础环境, "com.squareup:javapoet:1.13.0" 用于生产自定义的JAVA代码，动态生成代码处理我们储存的内容。

如何实现实现独立存在:app和:Library

1、自己生成CMakeLists文件

如果有NDK开发经验都应该知道，我们需要一个CMakeLists.txt文件去构建混合了Native C++的项目，而这个CMakeLists.txt很容易存在冲突等问题，包括同名的动态链接库也是，所以我们利用Gradle的Task任务进行，动态生成CMakeLists.txt,并且So库的名字也是不同名字，内容大致如下:

cmake_minimum_required(VERSION 3.4.1)

add_library(
        core-client //你的.So库名字，就是，生成结果是libcore-client.so文件，System.loadLibrary("core-client")
        
        SHARED

        src/main/cpp/core-client.cpp
        src/main/cpp/core-environment.cpp
        src/main/cpp/core-encryption.cpp
)

find_library(
              log-lib
              log )

target_link_libraries(
        core-client  //你的.So库名字
                     ${log-lib} )

有了这个关键因素那么我们就可以解决重复名字的.So库的问题了，自己改了这个名字，让互不干扰。

2、如何把Nativce方法动态绑定到我们的JAVA文件

既然我们的.So是独立的那么，我们调用这些方法的JAVA文件最好也是独立一个，这时候又要兼容app和libray的存在，就会出现包名路径不同，如果单纯的传统的native方法自动生成代码的不可行了

extern "C"
包_名_XXX_XXX_XX_名字(JNIEnv *env,jclass clazz)

这种不能满足我们的要求，我们需要动态注册方法

jint JNI_OnLoad(JavaVM *vm, void *reserved)// System.loadLibrary("") 加载

那我就在这里注册方法

extern "C" 
JNIEXPORT jstring JNICALL getString(JNIEnv *env,jclass clazz,jstring key_){
    return env->NewStringUTF(result);
}

JNINativeMethod methods[] = {
        { "getString", "(Ljava/lang/String;)Ljava/lang/String;",(void*)getString},
};

jint JNI_OnLoad(JavaVM *vm, void *reserved) {
    env->RegisterNatives(clazz, methods, sizeof(methods)/sizeof(JNINativeMethod));
    return JNI_VERSION_1_6;
    }
//对应JAVA的方法
public static native String getString(String key);

这个JNINativeMethod methods[]其实很好理解，第一个是方法名字，第二个是(参数)和返回值(return = what?),第三个指向的实现方法具体怎么填写，这里也不展开细讲。
找到这篇参考文章

3、支持两种加密方式

本项目采用最简单的两种对称加密方式：AES和DES

4、支持生成Java类或者Kotlin类

kotlin：

public object CoreClient {
  init {
    System.loadLibrary("app-core-client")
  }

  public external fun getString(key: String): String

  public fun getData(): String = getString("8d777f385d3dfec8815d20f7496026dc")
}

Java：

public final class CoreClient {
  static {
    System.loadLibrary("app-core-client");
  }

  private CoreClient() throws IllegalAccessException {
    throw new IllegalAccessException();
  }

  public static native String getString(String key);

  public static String getData() {
    return getString("8d777f385d3dfec8815d20f7496026dc");
  }
}

具体调用

由于库我已经上传到Jitpack了,所以需要在根目录的project中配置环境

buildscript {

repositories {
        google()
        jcenter()
        maven { setUrl("https://jitpack.io") }
    }

dependencies {
        classpath("com.occ.orca:orca.so:2.0.0-release14")
    }
}

然后在项目的module和app中build.gradle添加

plugins {
    id 'com.android.application'
    id 'Orca'
    id 'kotlin-android'
}

使用也很方便，在项目或者模块的build.gradle的里书写

android{
   Orca.go{
        isDebug = true //默认值为false，必须输入Signature 
        encryptMode = "des" // 输入AES或者DES，不用区分大小写
        isBuildKotlin = true //生成的类为Kotlin类
        storeSet{
            "data"{
                value = "4444444444"
            }
            "1223"{
                value = "888888" //命名数字开头，方法名会有下划线
            }
        }
    }
  }
  
  //这是我们调用的地方，注意CoreClient有包名的区分，不是把所有结果集合到同一个类里
  val data = CoreClient.getData()
  val data1 = CoreClient.get_1223()

4、使用注意

在C++层中，进行了判断签名的校验，如果签名校验错误会直接崩溃，字段为secretKey，而你们加密的所用到的Key则为字段signature，而控制是否输入signature由isDebug字段进行控制，都是小驼峰写法。

小结

本项目采用的AESEncryption和DESEncryption，提出的方案还有很多需要完善的处理，后续会考虑直接在C++层做加密的运算，欢迎各位Pull Request.

Androd开发：保存私密字符串到So库