苹果私有API检查工具开源项目

iOS-private-api-checker 苹果iOS私有API检查工具 Developer tool to scan iOS apps for private API usage before submitting to Apple https://github.com/hustcc/iOS-private-api-checker

iOS私有API检查工具

私有API检查的原因在于：苹果在app提审的时候，会检查app使用私有api的情况，对于使用了私有api的app，不予通过，这个工具的目地就是在提审之前检查一下，提高通过率。

一、如何使用

1. 构建私有api库

• db/dsidx_dbs.py文件为解析docSet.dsidx的库，请实现将docSet.dsidx内容导出到sqlite中。docSet.dsidx是xcode作为代码提示的数据库，表示是apple公开的公有api。

• 修改config.py中sdks_config字典，增加各个version的sdk路径，然后运行build_api_db.py，会自动解析私有api，存存储到sqlite中。

• (项目中的数据库内容是我编译sdk7.0的数据，可以直接用。)

2. 检查ipa私有api

运行方式有二，建议第二种web方式：

1. 修改iOS_private.py main方法中的ipa路径，运行即可。

2. 使用Web上传运行的方式，运行python run_web.py（请先配置flask运行环境），然后浏览器输入127.0.0.1:9527 将ipa拖入上传框等待即可看到检查结果。

二、检查原理

1. 通过mac上xcode的开发环境，找出不同sdk版本的public framework和private framework；通过class-dump反编译出public framework中的api，分别设置为集合PU和PR。

2. 通过xcode代码提示的sqlite数据库查询出所有的document api，设置为集合DA。

3. 那么PU - DA为公有framework中的私有api，设置为A

4. PR为私有framework中的api都不能使用，则私有api集合PRAPI = A + PR

5. 使用class-dump反编译ipa中的app文件，然后和PRAPI集合取交集即可获得。

6. 其中有一些细节的集合操作，来准确定位api，例如使用方法名和类名来唯一确定API方法。

三、参考项目

• RuntimeBrowser

• iOS-private-api-scanner

• iOS-api-scan.md

四、Note

1. 私有的api ＝ (class-dump Framework下的库生成的头文件中的api - (Framework下的头文件里的api = 有文档的api + 没有文档的api)) + PrivateFramework下的api。

2. 私有api在公开的Framework及私有的PrivateFramework都有。

3. 请暂时暂mac上运行，linux上暂时没有找到合适的、代替otool的工具，求推荐^^!