CollaRE 是一款用于协同逆向工程的工具，旨在让那些在项目过程中需要使用多种工具的团队能够协作，而无需在单独的位置共享文件。它还包含一个非常简单的用户管理功能，因此可以用作多项目服务器，让不同的团队在不同的项目上工作。
该工具的后端是一个简单的 Flask app，前面由运行在 Docker 中的 nginx 作为反向代理，它基于文件和保存相关数据的 JSON 格式清单（manifest）工作。前端是一个基于 PyQT 的 GUI 工具，界面简洁，可用于管理项目、处理二进制文件及其对应的逆向工程数据库。目前该工具支持 Binary Ninja、Cutter (Rizin)、Ghidra、Hopper Dissassembler、IDA、JEB 和 Android Studio (Decompiled by JADX)。该实现尽可能与这些工具的内部工作机制解耦，以避免受任何 API 变化的影响，因此不会以插件形式直接集成到这些工具中（下文描述的数据迁移插件除外）。它的工作方式纯粹是管理这些工具生成的文件（实际上仅基于众所周知的文件扩展名），并执行简单的 SVN 风格 check-out 和 check-in 操作。
从本仓库获取最新的二进制发行版，或克隆仓库后在 Linux 上运行 sudo python3 setup.py install，在 Windows 上使用命令行运行 python3 setup.py install。在 Linux 上，这会将工具安装到 PATH 中，之后只需使用 collare 命令即可运行它。在 Windows 上，根据你安装 Python 的方式不同，该文件会被放到 C:\Users\<USERNAME>\AppData\Local\Programs\Python\<PYTHON_VERSION>\Scripts\collare.exe。
对于基于 Gnome 的桌面环境，可以使用以下 desktop 文件（文件路径可能因 CollaRE 和 Python 的版本不同而变化）：
[Desktop Entry]
Type=Application
Encoding=UTF-8
Name=CollaRE
Exec=/usr/local/bin/collare
Icon=/usr/local/lib/python3.8/dist-packages/collare-1.2-py3.8.egg/collare/icons/collare.png
Terminal=false
要启用对 Cutter 的支持，请将文件 Cutter 添加到你的路径中（当打开 cmd/terminal 时，输入 Cutter 应能启动该应用程序）。
保存 Cutter (rizin) 项目时，你必须手动添加 .rzdb 后缀。不要移除文件已有的扩展名（例如 exe 或 so）。
要启用对 Binary Ninja 的支持，请将文件 binaryninja 添加到你的路径中（当打开 cmd/terminal 时，输入 binaryninja 应能启动该应用程序）。
Binary Ninja 默认会移除文件扩展名，但该工具已对此做了处理，因此无需手动补回原始文件扩展名。按默认路径原样保存项目即可成功推送本地的 bndb 数据库。
要启用对 Hopper Disassembler 的支持，请将文件 Hopper 添加到你的路径中（当打开 cmd/terminal 时，输入 Hopper 应能启动该应用程序）。
Hopper 默认会移除文件扩展名，但该工具已对此做了处理，因此无需手动补回原始文件扩展名。只需使用 Ctrl+S 保存项目即可成功推送本地的 hop 数据库。
要启用对 JEB 的支持，请将文件 jeb 添加到你的路径中（当打开 cmd/terminal 时，输入 jeb 应能启动该应用程序）。可以通过将对应操作系统的默认启动脚本重命名为 jeb 来实现（在 Windows 上实际上是 jeb.bat）。
要启用对 IDA 工具的支持，请将文件 ida64 和 ida 添加到你的路径中（当打开 cmd/terminal 时，输入 ida64/ida 应能启动该应用程序）。
要启用对该工具的支持，请将文件 ghidraRun 和 analyzeHeadless（Windows 下为 .bat）添加到你的路径中（当打开 cmd/terminal 时，输入 ghidraRun 应能启动该应用程序）。请注意，analyzeHeadless 位于 Ghidra 根目录的 support 文件夹中，因此请确保调整 PATH 以同时包含这两个文件。
使用 Ghidra 初始化数据库的过程要复杂一些，因为 Ghidra 不创建项目就无法处理文件。因此，为了能够推送 Ghidra 数据库（称为 ghdb），每当自动处理失败时（基本上只要处理的文件不是 ELF/PE），系统都会提示你手动创建项目，然后指定 gpr 文件的路径（对此深表抱歉）。
由于 APK 和 JAR 文件在逆向工程工作中经常遇到，CollaRE 工具也支持处理这些类型的文件。要启用对这些工具的支持，必须确保 android-studio 和 jadx 文件都在路径中（当打开 cmd/terminal 时，输入 android-studio/jadx 应能启动相应的应用程序）。JADX 工具用于对 JAR/APK 文件进行反编译，Android Studio 用于打开生成的文件。请注意，Android Studio 的使用是可选的，你可以将任何其他能处理 Gradle 项目的工具通过 android-studio 命令设置别名来代替（例如 IntelliJ IDEA）。
按照其自述文件中的说明部署服务端后，你需要将所使用的证书文件分发给应用程序的所有用户，并使用默认的 admin 账户（密码为 admin）通过 Admin 选项卡创建其他用户账户（不要忘记更改 admin 用户的密码）。配置好用户后，任何人都可以创建自己的项目并开始使用该工具。
要创建项目，用户必须首先通过输入 URL、凭据，并提供证书来验证服务器身份，从而完成对远程服务器的身份验证。之后，状态将变为 Connected，你可以选择或删除现有项目，也可以直接输入名称（仅限字母数字字符和 _）并选择参与该项目的用户来创建新项目（稍后可在 Admin 选项卡中更改）。请注意，创建项目的用户会自动被添加到用户列表中，因此你不必选择自己。
进入 Project View 选项卡后，你可以创建新文件夹（仅限字母数字字符和 _，抱歉），并使用拖放功能上传文件（或文件夹）。
由于该工具目前没有任何插件或原生钩子能够在项目保存时自动上传，因此在创建所需的数据库后，需要手动触发本地 DB 文件的上传。这可以通过右键单击已上传的二进制文件，然后选择你想要用来处理该二进制的工具来实现。你可以进行基本分析，但强烈建议直接保存文件而不做任何更改（Cutter 中需要附加 rzdb 除外，Ghidra 则是完全不同的流程）。不要更改路径和文件名。完成上述操作并关闭反汇编器后，只需右键单击二进制文件名并选择 Push Local DBs 选项即可。这将上传本地数据库，此后当你想要使用该 DB 文件时，需要执行 Check-out 操作。请注意，每个二进制文件都可以在各工具中分别处理，但每个二进制文件和工具的 DB 文件只能存在一个。
当你只想查看文件时，可以右键单击所需的 DB 文件并选择 Open File 选项（或直接双击）。如果该文件已签出给你，这将会打开本地文件，并且你可以自由地对 DB 文件进行任何更改。完成更改后（或者你只是想推送这些更改），可以选择 Check-in 选项。这会将更改上传到服务器，并提示你是否希望保持文件处于签出状态以便继续更改。如果要放弃本地更改，请从上下文菜单中选择 Undo Check-out 选项。这将放弃你的更改，并允许你继续使用服务器上的文件。如果不先执行 Check-out 操作就打开文件，则会以伪只读模式打开（你可以对 DB 文件进行更改，但这些更改将在下次签出或打开文件时丢失）。
该工具还支持对 DB 文件进行版本管理，每次 Check-in 操作都会计为 DB 文件的一个新版本。系统会提示你为版本输入注释，以便为该版本中应用的更改提供更多上下文。之后，你可以打开或签出文件的先前版本并基于这些版本继续工作。
本仓库中的 plugins 文件夹包含了受支持工具的插件，使你在使用多种工具处理同一个二进制文件时，可以在这些工具之间共享注释和函数名称。请按照你感兴趣的工具的标准插件安装说明进行安装。每个插件都提供 Import 和 Export 功能。当你计划在工具之间共享数据时，请务必先 Import 数据，以避免重命名已被其他人重命名的函数。如果插件有一些注意事项，这些注意事项会在相应插件的 README 文件中说明。请注意，这些插件旨在将数据迁移到其他工具，而不是供多人同时协作。
