如何提取 IOS Document_apis

关于IOS 私有库的搭建,⽹上的教程很少,目前为止,发现的⼀个⽐较好的⽂章,是教你私有库的搭建和扫描,但是⽂章因为存在时间⽐较⻓,套在现在框架中,难免有些不适⽤,我就在⼤神(Deft_MKJing宓珂璟)的基础上,做⼀些补充和修改。在这⾥,我想感谢下⼤神的奉献和先驱者们的探索,我也把⾃⼰的经验分享出来,做⼀点贡献。

我之前出了一个提取IOS Run-header的文章,和这个文章相当于是系列文章,这篇文章主要是教大家怎么提取 document_apis, 也就是大神文章中集合C。这里针对的是IOS 15.0版本。

回顾

/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk

版本查看可以在路径下 SDKSettings.json 文件中看到

文章中关于9.0版本后,Xcode 9之后的API 内置在一个Framework里面,主要是两个文件:map.db 和 cache.db, 路径为:

/Applications/Xcode.app/Contents/SharedFrameworks/DNTDocumentationSupport.framework/Versions/A/Resources/external

那么问题就出来了,在我们最新的环境中,文档是好像是内嵌了个浏览器的形式展现的,同时,也找不到map.db 文件,所以这里,我们需要调整下。

获取 document_apis 我目前总结了两种。lzfse 方法和 Dash 方式,我们先说 lzfse 的方式,再说,Dash 的方式就比较容易理解。并且,Dash 的方式API 不是很全面,所以,Dash 不是很赞成。

01

lzfse 方式

/Applications/Xcode.app/Contents/SharedFrameworks/DNTDocumentationSupport.framework/Versions/A/Resources/external

在上面的路径下,我们可以看到一个 cache.db 文件,和一个 fs 的文件夹,

cache.db 是一个数据库文件,

cache.db 数据解析:

row_id: id
uuid: 现在的文档因为是在线查看,文档中还包含了很多图片,视频,文本等内容, uuid 是内置浏览器加载的uuid, 我们在抽取 document_apis 的时候,只需要解析文本文件即可。
data_id: 当前 uuid 对应在 fs 文件下的文件名。
offset: 因为 fs 是字节码文件,我们读文件的时候,这个字段可以标识读取字节码开始位置。
lenght: 当前 uuid 所占字节码文件中的长度。

metadat json 对象字段说明:
title: API name
roleHeading: 当前所属类型, instance method就是实例方法,function 是c语言的函数。
e xternalID:当前id, 包含类库名,头文件名,function 类型没有头文件名,所以这部分API 的提取需要全局查找,不允许重复定义。

02

Dash 方式

这种提取方式是依据Dash 软件提取的,这种提取方式提取的API 比较方便,快捷,但是也有一定的缺陷:

  1. 没有头文件的定义

  2. API 不全,可能会有缺失

~/Library/Application Support/Dash/DocSets

打开后有两张表,一个是 searchindex ,另外一个是 cache

searchindex表说明:
id : 标识id
name:API 名,类名...
type:类型,当前所属方法还是类....
path: 文档路径

cache表说明:
id: 标识id
name:同上
request_key: 可以根据path路径提取request_key
request_key_alias: uuid,这里的uuid和上面的uuid是一个意思。

Dash这种方式也是可以提取出API 的,但是个人感觉不太准确,不能用作构建私有库的API。

结果

最后,本章的内容就介绍完毕,再次感谢各位程序员,测试人员在探索的道路上不断的付出,也希望有机会和大家一起研究探讨。

参考文献

https://github.com/ydkhatri/pyliblzfse