Skip to main content

Obfuz+XLua

本工程演示如何将Obfuz与XLua一起使用，完整示例项目参见WorkWithXLua。

详细文档见与XLua协同工作。

安装​

安装以下插件：

  • com.code-philosophy.obfuz https://github.com/focus-creative-games/obfuz.git
  • xlua https://github.com/Tencent/xLua

由于xlua并未直接提供单独的package仓库，本示例项目在xLua仓库基础上直接修改而来。

创建代码​

Assets目录下创建Bootstrap.cs类，代码如下：

using Obfuz;
using Obfuz.EncryptionVM;
using System.Collections;
using System.Collections.Generic;
using Tutorial;
using UnityEngine;


public class Bootstrap : MonoBehaviour
{
    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.AfterAssembliesLoaded)]
    private static void SetUpStaticSecretKey()
    {
        //Debug.Log("SetUpStaticSecret begin");
        EncryptionService<DefaultStaticEncryptionScope>.Encryptor = new GeneratedEncryptionVirtualMachine(Resources.Load<TextAsset>("Obfuz/defaultStaticSecretKey").bytes);
        //Debug.Log("SetUpStaticSecret end");
    }

    private void Awake()
    {
        ObfuscationInstincts.RegisterReflectionType<BaseClass>();
        ObfuscationInstincts.RegisterReflectionType<DerivedClass>();
        ObfuscationInstincts.RegisterReflectionType<Tutorial.ICalc>();
        ObfuscationInstincts.RegisterReflectionType<DerivedClass.InnerCalc>();
        ObfuscationInstincts.RegisterReflectionType<DerivedClass.TestEnumInner>();
        ObfuscationInstincts.RegisterReflectionType<Tutorial.TestEnum>();
    }

    void Start()
    {
        Debug.Log("Hello, Obfuz");
    }
}

编辑场景​

将Boostrap及Tutorial.LuaCallCs脚本挂载到场景中。

Tutorial.LuaCallCs是xLua仓库中自带的演示脚本，位置在Assets/XLua/Tutorial/CSharpCallLua目录。

配置​

  • 将Assembly-CSharp加入ObfuzSettings.AssembliesToObfuscate列表

生成加密虚拟机及密钥​

  • 运行菜单Obfuz/GenerateEncryptionVM生成加密虚拟机代码，默认生成的代码文件为Assets/Obfuz/GeneratedEncryptionVirtualMachine.cs。
  • 运行菜单Obfuz/GenerateSecretKeyFile生成两个密钥文件。默认输出文件为Assets/Resources/Obfuz/defaultStaticSecretKey.bytes和Assets/Resources/Obfuz/defaultDynamicSecretKey.bytes

注册xLua中访问的类型​

xLua注册C#类型时并不是直接使用类型名，而是调用了Type.FullName，这导致混淆后lua代码中访问C#类出现type not found的错误！

比较彻底的办法是调整xlua实现，类型名在生成wrapper代码时直接确定，但这种改法比较复杂。我们采取了一种比较简单的方案：利用Obfuz提供的ObfuscationTypeMapper, 获取Type对应的原始类型名，修改xLua中所有调用Type.FullName的代码，改为ObfuscationTypeMapper.GetOriginalTypeFullNameOrCurrent。

为了ObfuscationTypeMapper能正确工作，要求提前注册Type和原始类型全名的映射关系。直接手写类型全名很容易出错，ObfuscationInstincts::RegisterReflectionType提供一种非常便捷的注册方式。

我们在Bootstrap.Awake函数中添加了注册代码。

打包&运行​

在Build Settings中运行Build And Run构建并且运行，查看player.log验证其确实正确运行。