joern

Joern - Bug 猎人的工作台

Joern 是一个用于分析源代码、字节码和二进制可执行文件的平台。它生成代码属性图（CPG），这是用于跨语言代码分析的代码的图形表示。代码属性图存储在自定义图形数据库中。这允许使用以基于 Scala 的特定领域查询语言制定的搜索查询来挖掘代码。 Joern 的开发目标是为静态程序分析中的漏洞发现和研究提供有用的工具。

网站：https://joern.io

文档：https://docs.joern.io/

规范：https://cpg.joern.io

新闻/变更日志

• Joern v4.0.0 从overflowdb迁移到flatgraph
• Joern v2.0.0 从 Scala2 升级到 Scala3
• Joern v1.2.0 删除了overflowdb.traversal.Traversal类。此更改不完全向后兼容。请参阅此处了解详细的文章。

要求

• JDK 21（其他版本可能可以工作，但尚未经过正确测试）
• 可选：gcc 和 g++（用于自动发现 C/C++ 系统头文件（如果在 C/C++ 代码中包含/使用））

开发需求

• mvn https://maven.apache.org/install.html

快速安装

 wget https://github.com/joernio/joern/releases/latest/download/joern-install.sh
chmod +x ./joern-install.sh
sudo ./joern-install.sh
joern

     ██╗ ██████╗ ███████╗██████╗ ███╗   ██╗
     ██║██╔═══██╗██╔════╝██╔══██╗████╗  ██║
     ██║██║   ██║█████╗  ██████╔╝██╔██╗ ██║
██   ██║██║   ██║██╔══╝  ██╔══██╗██║╚██╗██║
╚█████╔╝╚██████╔╝███████╗██║  ██║██║ ╚████║
 ╚════╝  ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝
Version: 2.0.1
Type `help` to begin

joern>

如果安装脚本因任何原因失败，请尝试

 ./joern-install --interactive

基于 Docker 的执行

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern

要在服务器模式下运行 joern：

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern --server

Almalinux 9要求CPU支持SSE4.2。对于 kvm64 VM，请改用 Almalinux 8 版本。

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern-alma8 joern

发布

每天自动创建一次新版本。如果贡献者需要更快地发布，他们还可以手动运行发布工作流程。

开发商

贡献指南

感谢您抽出时间为 Joern 做出贡献！以下是一些确保您的拉取请求尽快合并的指南：

• 尝试尽可能使用模板，但它们可能无法满足所有需求。我们希望看到的最低限度是：
  • 简要描述 PR 的更改和目的的标题，最好将受影响的模块放在方括号中，例如[javasrc2cpg] Addition Operator Fix 。
  • PR 正文变化的简短描述。这可以是要点或段落。
  • 相关问题的链接或参考（如果存在）。
• 不要：
  • 立即抄送/@/电子邮件垃圾邮件其他贡献者，团队将审查 PR 并指派最合适的贡献者来审查 PR。 Joern 由行业合作伙伴和研究人员等维护，大部分都有自己的目标和优先事项，额外的帮助主要是志愿者工作。如果您的 PR 变得过时，请在后续评论中通过 @ 联系我们，要求解释优先级或计划何时解决（如果有的话，取决于质量）。
  • 将描述正文留空，这使得审查 PR 的目的变得困难。
• 请记住：
  • 请记住格式化您的代码，即运行sbt scalafmt Test/scalafmt
  • 添加单元测试来验证您的更改。

IDE设置

Intellij IDEA

• 下载 Intellij 社区
• 安装并运行它
• 安装 Scala 插件 - 只需从 Intellij 中搜索并安装即可。
• 重要提示：在本地 joern 存储库中打开sbt ，运行compile并保持打开状态 - 这将允许我们在下一步中使用 BSP 构建
• 返回 Intellij：打开项目：选择本地 joern 克隆：选择以BSP project打开（即不是sbt project ！）
• 等待导入和索引完成，然后您可以开始，例如Build -> build project或运行测试

VS代码

• 安装 VSCode 和 Docker
• 安装插件ms-vscode-remote.remote-containers
• 在 VSCode 中打开 Joern 项目文件夹 Visual Studio Code 检测到新文件并打开一个消息框，显示： Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• 选择Reopen in Container按钮以重新打开由.devcontainer/Dockerfile文件创建的容器中的文件夹
• 在 VSCode 中切换到scalameta.metals侧边栏，然后在BUILD COMMANDS中选择import build
• import build成功后，就可以开始为 Joern 编写代码了

QueryDB（查询插件）

开发和测试 QueryDB 的快速方法：

 sbt stage
./querydb-install.sh
./joern-scan --list-query-names

最后一个命令打印所有可用的查询 - 在 querydb 中添加您自己的查询，再次运行上述命令以查看您的查询是否已部署。更多详细信息请参见单独的 querydb 自述文件