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 自述文件