Slither：スマートコントラクト静的解析ツール

Empire Hacking Slack に参加

- 議論とサポート

Slither は、Python3 で書かれた Solidity および Vyper の静的解析フレームワークです。脆弱性検出器一式を実行し、コントラクトの詳細に関する視覚情報を出力し、カスタム解析を簡単に記述するための API を提供します。Slither により、開発者は脆弱性の発見、コード理解の向上、カスタム解析の迅速なプロトタイピングが可能になります。

• 特徴
• 使い方
• インストール方法
  • uv を使用 (推奨)
  • Pip を使用
  • Git を使用
  • Docker を使用
  • 統合
• 検出器
• プリンター
  • クイックレビュープリンター
  • 詳細レビュープリンター
• ツール
• API ドキュメント
• ヘルプ
• FAQ
• ライセンス
• 出版物
  • Trail of Bits の出版物
  • 外部の出版物

特徴

• 誤検出の少ない脆弱な Solidity コードの検出（トロフィーのリストを参照）
• ソースコード内のエラー発生箇所の特定
• 継続的インテグレーションおよび Hardhat/Foundry ビルドへの容易な統合
• 組み込みの「プリンター」による重要なコントラクト情報の迅速なレポート
• カスタム解析を Python で記述するための検出器 API
• Solidity >= 0.4 で書かれたコントラクトの解析機能
• 中間表現 (SlithIR) によるシンプルかつ高精度な解析
• 公開されている Solidity コードの 99.9% を正しくパース
• コントラクトあたりの平均実行時間は 1 秒未満
• CI における GitHub のコードスキャンとの統合
• Vyper スマートコントラクトのサポート

使い方

Slither を Hardhat/Foundry/Dapp/Brownie アプリケーションで実行：```console slither .

これは、プロジェクトに依存関係がある場合の推奨されるオプションです。Slitherは基盤となるコンパイルフレームワークに依存してソースコードをコンパイルします。

ただし、依存関係をインポートしない単一ファイル上でSlitherを実行することもできます:```console
slither tests/uninitialized.sol

インストール方法

注記 SlitherはPython 3.10以上が必要です。 サポートされているコンパイルフレームワークのいずれかを使用しない場合は、Solidityコンパイラであるsolcが必要です。solcのバージョンを簡単に切り替えるには、solc-selectの使用をお勧めします。

uvを使用する（推奨）

uvは高速なPythonパッケージマネージャで、pipよりも10〜100倍高速です。```console

Install uv if you haven't already

curl -LsSf https://astral.sh/uv/install.sh | sh

Install slither as a tool

uv tool install slither-analyzer

Or run slither without installation

uvx --from slither-analyzer slither

アップグレードするには:```console
uv tool upgrade slither-analyzer

Pipを使用する```console

python3 -m pip install slither-analyzer

アップグレードするには:```console
python3 -m pip install --upgrade slither-analyzer

Brew を使用する```console

brew install slither-analyzer

### Gitの使用（開発）```bash
git clone https://github.com/crytic/slither.git && cd slither

# Install as editable for development
uv tool install -e .

# Or use uv run for testing without installation
uv run slither <target>

The -eフラグは編集可能モードでインストールします。つまり、ソースコードへの変更は再インストールなしで即座に反映されます。

Dockerの使用

eth-security-toolbox Dockerイメージを使用してください。これには、すべてのセキュリティツールと、主要なすべてのバージョンのSolidityが1つのイメージに含まれています。 /home/share はコンテナ内の /share にマウントされます。```bash docker pull trailofbits/eth-security-toolbox

コンテナ内でディレクトリを共有するには：```bash
docker run -it -v /home/share:/share trailofbits/eth-security-toolbox

統合

• GitHub Actionとの統合には、slither-actionを使用してください。
• pre-commitとの統合には、 ($GIT_TAG を実際のタグに置き換えて) 使用してください ```YAML
  • repo: https://github.com/crytic/slither rev: $GIT_TAG hooks:
    • id: slither
  root@kitploit:~

• マークダウンレポートを生成するには、slither [target] --checklist を使用します。
• GitHub のソースコードハイライト付きマークダウンを生成するには、slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/ を使用します（ORG、REPO、COMMIT を置き換えてください）。

検出器

詳細については、以下を参照してください。

• 各検出器の詳細については、検出器ドキュメント
• 選択した検出器のみを実行するには、検出器選択。デフォルトでは、すべての検出器が実行されます。
• 個々の結果をフィルタリングするには、トリアージモード

プリンター

クイックレビュープリンター

• human-summary: コントラクトの人間が読める概要を出力
• inheritance-graph: 各コントラクトの継承グラフを dot ファイルにエクスポート
• contract-summary: コントラクトの概要を出力
• loc: ソースファイル（SRC）、依存関係（DEP）、テストファイル（TEST）にあるコード行数（LOC）、ソースコード行数（SLOC）、コメント行数（CLOC）の合計をカウント
• entry-points: コントラクトのすべての状態変更エントリポイント関数とその変数を出力

詳細レビュープリンター* call-graph: コントラクトのコールグラフをdotファイルにエクスポートする

• cfg: 各関数のCFGをエクスポートする
• function-summary: 関数のサマリーを出力する
• vars-and-auth: 書き込まれる状態変数と関数の認可を出力する
• not-pausable: whenNotPaused 修飾子を使用しない関数を出力する

プリンタを実行するには、--print を使用し、カンマ区切りでプリンタのリストを指定します。

完全なリストについては、プリンタドキュメント を参照してください。

ツール

• slither-check-upgradeability: delegatecall ベースのアップグレード可能性をレビューする
• slither-prop: 自動単体テストとプロパティ生成
• slither-flat: コードベースをフラット化する
• slither-check-erc: ERC 準拠をチェックする
• slither-read-storage: コントラクトからストレージ値を読み取る
• slither-interface: コントラクトのインターフェースを生成する

追加のツールについては、ツールドキュメント を参照してください。

カスタムツールの構築に関する支援については、お問い合わせください。

APIドキュメント

Slither の内部に関するドキュメントはこちらで入手できます。

ヘルプ

Slither の使用または拡張についてのヘルプは、Slack チャンネル (#ethereum) にお気軽にお立ち寄りください。

• プリンタドキュメント は、Slither が各コントラクトについて可視化できる情報を説明しています。
• ディテクタドキュメント は、新しい脆弱性分析の書き方を説明しています。
• APIドキュメント は、カスタム分析で利用可能なメソッドとオブジェクトを説明しています。
• SlithIRドキュメント は、SlithIR 中間表現を説明しています。

FAQ

モックやテストを除外するにはどうすればよいですか？

• パスフィルタリング に関するドキュメントを参照してください。

「unknown file」やコンパイルの問題を修正するにはどうすればよいですか？

• slither は solc AST を必要とするため、すべての依存関係が利用可能でなければなりません。 コントラクトに依存関係がある場合、slither contract.sol は失敗します。 代わりに、contracts/ の親ディレクトリで slither . を使用してください（ls を実行すると contracts/ が表示されるはずです）。 node_modules/ フォルダがある場合は、contracts/ と同じディレクトリになければなりません。この問題が slither に関連していることを確認するには、 使用しているフレームワークのコンパイルコマンド（例：npx hardhat compile）を実行してください。それが正常に動作する必要があります。 そうでない場合、slither のコンパイルエンジンである crytic-compile は AST を生成できません。

ライセンス

Slither は AGPLv3 ライセンスの下でライセンスおよび配布されています。条件の例外を求める場合は、お問い合わせください。

出版物

Trail of Bits の出版物

• Slither: スマートコントラクトのための静的解析フレームワーク, Josselin Feist, Gustavo Grieco, Alex Groce - WETSEB '19

外部出版物

学術研究で Slither を使用している場合は、Crytic $10k 研究賞 への応募をご検討ください。