joern

Joern - バグハンターの作業台

Joern は、ソース コード、バイトコード、およびバイナリ実行可能ファイルを分析するためのプラットフォームです。言語間コード分析のためのコードのグラフ表現であるコード プロパティ グラフ (CPG) を生成します。コード プロパティ グラフはカスタム グラフ データベースに保存されます。これにより、Scala ベースのドメイン固有のクエリ言語で作成された検索クエリを使用してコードをマイニングできるようになります。 Joern は、静的プログラム分析における脆弱性の発見と研究に役立つツールを提供することを目的として開発されました。

ウェブサイト: https://joern.io

ドキュメント: https://docs.joern.io/

仕様: https://cpg.joern.io

ニュース / 変更履歴

• Joern v4.0.0 が overflowdb から flatgraph に移行
• Jorn 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

リリース

新しいリリースは 1 日に 1 回自動的に作成されます。より早くリリースが必要な場合、貢献者はリリース ワークフローを手動で実行することもできます。

開発者

貢献ガイドライン

Joern に貢献していただきありがとうございます。プル リクエストができるだけ早くマージされるようにするためのガイドラインをいくつか示します。

• 可能な限りテンプレートを使用するようにしてください。ただし、すべてのニーズに適合するとは限りません。最低限確認しておきたいのは次のとおりです。
  • PR の変更と目的を簡単に説明するタイトル。できれば影響を受けるモジュールを角括弧で囲みます。例: [javasrc2cpg] Addition Operator Fix 。
  • PR 本文の変更点の簡単な説明。これは箇条書きまたは段落で行うことができます。
  • 関連する問題へのリンクまたは参照 (存在する場合)。
• しないでください：
  • 他の投稿者に直ちに CC/@/電子メールでスパム送信すると、チームは PR をレビューし、PR をレビューするために最も適切な投稿者を割り当てます。 Jorn は、業界パートナーや研究者によって同様に維持されており、ほとんどの場合、独自の目標と優先事項を持っており、追加の支援は主にボランティア活動です。あなたの PR が陳腐化している場合は、@ を付けてフォローアップ コメントでご連絡いただき、優先順位の説明や、対応する時期の計画 (もしあれば、品質に応じて) を求めてください。
  • 説明本文を空のままにすると、PR の目的を確認することが難しくなります。
• 次のことを忘れないでください。
  • コードをフォーマットすることを忘れないでください。つまり、 sbt scalafmt Test/scalafmt実行します。
  • 単体テストを追加して変更を検証します。

IDEのセットアップ

インテリジアイデア

• 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 で Jorn プロジェクト フォルダーを開く 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 readme を参照してください。