Aderyn

🚀 Aderyn

Aderynは、スマートコントラクトを俯瞰して解析する強力なSolidity静的解析ツールです。セキュリティ上の脆弱性を見つけるのに役立ち、プロトコルエンジニアやセキュリティ研究者に最適です。

🚀 クイックスタート

クイックスタートの例とビデオガイドが用意されています。

cd path/to/solidity/project/root
aderyn

これにより、report.mdが生成されます。 より多くのCLIオプションを使用した例はこちらを参照してください。

✨ 主な機能

• Foundryプロジェクトをそのままサポート
• Hardhatプロジェクトをそのままサポート（場合によってはremappings.txtが必要）
• カスタムフレームワークをサポートするための設定ファイル（adeyrn.toml）
• Markdown、JSON、Sarif形式のレポート

📦 インストール

⚠️ 重要提示

WindowsユーザーはWSLをインストールする必要があります。

Cyfrinupを使用する場合

Cyfrinupは、Cyfrinツールのクロスプラットフォームインストールマネージャーです。 一度のセットアップが必要です。

インストールを確認するには、aderyn --versionを実行します。 すべてを最新バージョンにアップグレードするには、cyfrinupを実行します。

curlを使用する場合

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/cyfrin/aderyn/releases/latest/download/aderyn-installer.sh | bash

古いバージョンをアップグレードするには、aderyn-updateを実行します。

Homebrewを使用する場合

brew install cyfrin/tap/aderyn

古いバージョンをアップグレードするには、brew upgrade cyfrin/tap/aderynを実行します。

npmを使用する場合

npm install @cyfrin/aderyn -g

古いバージョンを（再）インストールするには、npm install @cyfrin/aderyn -gを実行します。

Curl、Homebrew、またはnpmでインストールする場合、パス内の正しいバージョンのAderynがHomebrewまたはnpmのグローバルパッケージディレクトリから来ていることを確認してください。~/.cyfrin/bin/aderynに古いバージョンが存在する場合は、rm -f ~/.cyfrin/bin/aderynを使用して削除してください。これはもはやデフォルトのインストール場所ではありません。

📚 ドキュメント

Aderynの機能について詳しく知りたい場合は、Cyfrin公式ドキュメントを参照してください。

また、公式にサポートされているVSCode拡張機能もあります。Visual Studio Marketplaceからダウンロードして、Solidityコードの脆弱性を簡単に特定できます。

📄 ライセンス

Aderynは、GPL-3.0 Licenseの下で公開されているオープンソースソフトウェアです。

Aderynの開発を支援してください🦜 詳細な開発環境のセットアップとPRの承認プロセスについては、コントリビューションガイドラインを参照してください。

🔧 カスタムAderyn検出器の構築

Aderynを使用すると、任意のSolidityコードベースやプロトコルに適応できる静的解析検出器を簡単に構築できます。このガイドでは、カスタムAderyn検出器の構築、テスト、実行方法を学びます。 カスタムAderyn検出器の作成方法については、公式ドキュメントを参照してください。

👏 クレジット

このプロジェクトは、貢献者の皆さんのおかげで成り立っています。

🔗 引用元

• AST Visitorコードは、solc-ast-rsから取得
• バックエンドAST生成には、Foundry Compilers foundry-compilersを使用
• 元の検出器は、4naly3erの検出器に基づいています
• 静的解析の第一人者であるslitherに敬意を表します
• Solidity AST Generatorは、solidity-ast-rsを使用