Lua程序逆向之Luajit文件格式-bin文件格式

Luajit简介

Luajit将原生Lua进行了扩展，使它支持JIT方式编译运行，比起原生Lua程序，它有着如下特点：

JIT即时编译器让执行效率更高。

它同时兼容传统的AOT编译。

全新设计的Luajit字节码文件格式，更加高效与更强的调试支持。（这一点在后面会着重介绍）

全新的Lua指令集。引入了中间表示IR，以及编译引擎支持不同平台的处理器指令即时编译，完全的符合现代化编译器设计，是编译理论学习的绝佳好资料。

Luajit在游戏软件中应用广泛，学习Lua程序逆向，就避免不了与Luajit打交道。下面，我们以最基本的Luajit文件格式开始，逐步深入的学习Lua程序的逆向基本知识。

安装Luajit

Luajit是开源的，它的项目地址是：https://github.com/LuaDist/luajit 。任何人都可以从网络上下载编译并安装它。

目前，最新正式版本的Luajit为2.0.5版，Beta版本为2.1.0-beta3版，官方还在缓慢的更新中。正式版本的Luajit只只兼容Lua的5.1版本，5.2版本的Lua正在添加支持中。这里重点讨论Luajit2.0.5正式版本。

笔者研究Luajit使用的操作系统是macOS，通过Homebrew软件包管理工具，可以执行如下的命令进行快速的安装：

安装完成后，它的目录结构如下所示：

安装目录下的luajit程序是指向luajit-2.0.5程序的软链接，它是Luajit的主程序，与Lua官方的lua程序一样，它是Luajit程序的解释器，不同的是，它没有与luac编译器对应的Luajitc，Luajit同时负责了Lua文件编译为Luajit字节码文件的编译工作。include目录下存放的是Luajit的头文件，可以编译C/C程序与Luajit进行交互。lib目录为链接C/C程序用到的库文件。share/luajit-2.0.5/jit目录下的lua文件是Luajit提供的扩展模块，可以用来反汇编与Dump输出Luajit字节码文件的指令信息，在学习Luajit字节码指令格式时，这些工具非常有用。man目录下提供了Luajit的man帮助信息，即终端中执行man luajit显示的帮助内容。

编译生成Luajit文件

编写hello.lua文件，内容如下：

这段代码包含了三个函数、一个局部变量，一条返回语句。使用luajit的-b参数即可生成hello.luajit文件，命令如下所示：

上面命令生成的hello.luajit文件不包含调试信息，luajit默认编译参数中有一个-s参数，作用是去除luajit文件中的调试信息。调度信息中，包含了原Lua源文件中的行号与变量本等信息，如果想要保留这些信息，可以加上-g参数。执行如下命令，可以生成带调试信息的hello_debug.luajit文件：

Luajit文件格式

Luajit官方并没有直接给出Luajit字节码文件的格式文档。但可以通过阅读Luajit源码中加载与生成Luajit字节码文件的函数，来单步跟踪分析出它的文件格式，这两个方法分别是lj_bcread()与lj_bcwrite()。

从这两个函数调用的bcread_header()、bcread_proto()、bcwrite_header()、bcwrite_proto()等子函数名可以初步了解到，Luajit字节码文件与Luac一样，将文件格式分为头部分信息Header与函数信息Proto两部分。具体的内容细节则需要使用gdb或lldb等工具调试分析得出。

Luajit字节码文件的Header部分为了与Luac命名上保持一致，这里将其描述为GlobalHeader，它的定义如下：

第一个signature字段是Luajit文件的Magic Number，它占用三个字节，定义分别如下：

读取uleb128表示的数据大小的方法如下：

接下来GlobalHeader中，如果判断Luajit文件中包含调试信息，即flags字段中的FLAG_IS_STRIPPED没有被置位，则会多出length与chunkname两个字段。length是uleb128表示的字段串长度，chunkname则是存放了length长度的字段串内容，它表示当前Luajit文件的源文件名。

在GlobalHeader之后，是Proto函数体内容。它的定义如下：

这里Proto的定义仍然采用与上面GlobalHeader一样的010 Editor模板语法方式，这种类似C语言的描述，更容易从定义上看出Proto结构体的字段信息。

ProtoHeader类型的header字段描述了Proto的头部信息，定义如下：

size字段是标识了从当前字段开始，整个Proto结构体的大小，当该字段的取值大于0时，表示当前Proto不为空，即Proto的header字段后，接下来会包含Instruction指令与Constants常量等信息，并且ProtoHeader部分也会多出其他几个字段。首先是flags字段，ProtoFlags是一个uchar类型，这里单独使用一个结构体表示，是为了之后编写010 Editor模板时，更方便的为其编写read方法。ProtoFlags取值如下：

FLAG_HAS_CHILD标识当前Proto是一个“子函数”，即闭包(Closure)。这个标志位非常重要，为了更好的理解它的用处，先看下如下代码：

这段Lua代码中，最外层的Create()向内，每个function都包含一个Closure。现在回忆一下Luac文件格式中，它们是如何存储的？

在Luac文件中，每个Proto都有一个Protos字段，它用来描述Proto与Closure之间的层次信息，Proto采用从外向内的递归方式进行存储。而Luajit则采用线性的从内向外的同级结构进行存储，Proto与Closure之前的层级关系使用flags字段的FLAG_HAS_CHILD标志位进行标识，当flags字段的FLAG_HAS_CHILD标志位被置位，则表示当前层的Proto是上一层Proto的Closure。

上面的代码片断在Luajit文件结构中的存局如下所示：

从存局中可以看出，最内层的foo3()位于Proto的最外层，它与Luac的布局恰恰是相反的，而proto[4]表示了整个Lua文件，它是Proto的最上层。最后的proto[5]，它在读取其ProtoHeader的size字段时，由于其值为0，而中止了整个文件的解析。即它的内容为空。

FLAG_IS_VARIADIC标识了当前Proto是否返回多个值，上面的代码中，只有Create()的flags字段会对该标志置位。FLAG_HAS_FFI标识当前Proto是否有通过FFI扩展调用系统的功能函数。FLAG_JIT_DISABLED标识当前Proto是否禁用JIT，对于包含了具体代码的Proto，它的值通常没有没有被置位，表示有JIT代码。FLAG_HAS_ILOOP标识了当前Proto是否包含了ILOOP与JLOOP等指令。

在flags字段后面，是arguments_count字段，表示当前Proto有几个参数。接着是framesize字段，标识了Proto使用的栈大小。接下来四个字段upvalues_count、complex_constants_count、numeric_constants_count、instructions_count，它们分别表示UpValue个数、复合常数、数值常数、指令条数等信息。

如果当前Proto包含调试信息，则接下来是3个uleb128类型的字段debuginfo_size、first_line_number、lines_count。其中debuginfo_size字段指明后面DebugInfo结构体占用的字节大小，first_line_number指明当前Proto在源文件中的起始行，lines_count字段指明当前Proto在源文件中所占的行数。

如果上面的instructions_count字段值不为0，接下来则存放的是指令Instruction数组，每条指令长度与Luac一样，占用32位，但使用的指令格式完全不同，此处不展开讨论它。

指令后面是常量信息，它的定义如下：

可以看到，Constants中包含3个数组字段，每个字段的具体数目与前面指定的upvalues_count、complex_constants_count、numeric_constants_count相关。每个UpValue信息占用16位，ComplexConstant保存的常量信息比较丰富，它可以保存字符串、整型、浮点型、TAB表结构等信息。它的结构体开始处是一个uleb128类型的tp字段，描述了ComplexConstant保存的具体的数据。它的类型包括：

这里重点关注下`BCDUMP_KGC_TAB，它表示这是一个Table表结构，即类似如下代码片断生成的数据内容：

Table数据在Luajit中有专门的数据结构进行存储，它的定义如下：

有基于数组的ArrayItem与基于Hash的HashItem两种Table类型结构，上面的tab即属于HashItem，它的定义如下：

TableItem描述了Table的键key与值value的类型与具体的数据内容，它的开始处是一个uleb128类型的tp字段，具体的取值类型如下：

当取到tp的类型值后，判断它的具体类型，然后接下来存放的即是具体的数据，TableItem在010 Editor中的模板结构体表示如下:

当取值大于5，即大于BCDUMP_KTAB_STR时，它的类型为字符串，需要减去5后计算出它的实际内容长度。另外，上面的TNumber是由两个uleb128组成的分为高与低各32位的数据类型。

NumericConstant存储数值型的常量，比如local语句中赋值的整型与浮点型数据。它的定义如下：

数值常量分为lo低部分与hi高部分，注意lo的类型为uleb128_33，它是一个33位版本的uleb128，即判断第一个字节后面是否还包含后续数据时，首先判断第33位是否置1。它的定义如下：

当读取到lo的最低为是1时，说明这是一个TNumber类型，还需要解析它的高32位部分。

在Constants常量结构体后面，如果ProtoHeader的debuginfo_size值大于0，那么接下来此处存放的是Debuginfo调试信息，它的定义如下：

分为LineInfo与VarInfos两部分，前者是存储的一条条的行信息，后者是局部变量信息。VarInfos中存储了变量的类型、名称、以及它的作用域起始地址与结束地址，它的定义如下：

代码中的指令引用一个局部变量时，调试器可以通过其slot槽索引值到VarInfos中查找它的符号信息，这也是Luajit文件支持源码级调试的主要方法。

编写Luajit文件的010 Editor文件模板

在掌握了Luajit的完整格式后，编写010 Editor文件模板应该没有难度与悬念了。

Luajit的线性结构解析起来比Luac简单，只需要按顺序解析Proto，直接读取到字节0结束。整体部分的代码片断如下：

Proto的header的size字段是当前Proto的大小，在解析的时候有必要对其合法性进行检查。

在编写模板时，只遇到过一个比较难解决的问题，那就是对NumericConstant中浮点数的解析。如下面的代码片断：

编译生成Luajit文件后，它会以浮点数据存储进入NumericConstant结构体中，并且它对应的64位数据为0x400921FB4D12D84A。在解析该数据时，并不能像Luac中TValue那样直接进行解析，Luac中声明的结构体TValue可以直接解析其内容，但Luajit中0x400921FB4D12D84A值的lo与hi是通过uleb128_33与uleb128两种数据类型动态计算才能得到。

将0x400921FB4D12D84A解析为double，虽然在C语言中只需要如下代码：

010 Editor虽然支持结构体与UNION，但并不支持声明local类型的结构体变量。所以，浮点数据的解析工作一度陷入了困境！最后，在010 Editor的帮且文档中执行“double”关键字，查找是否有相应的解决方法，最后找到了一个ConvertBytesToDouble()方法，编写代码进行测试：

输出如下：

可见，不是直接进行的内存布局转换，而是进行了内部的计算转换，虽然与原来的3.1415926有少许的出入，但比起不能转换还是要强上许多，通过ConvertBytesToDouble()，可以为NumericConstant编写其read方法，代码如下：

最后，编写完成后，效果如图所示： luajit

完整的luajit.bt文件可以在这里找到：https://github.com/feicong/lua_re 。