
フレームワーク対応の静的コード解析ツールで、自動ソースコードレビュー、プラットフォーム固有のルール、汚染解析、工数見積もり、抑制ベースラインを備えています。
Author:
- Debasis Mohanty ([email protected])
- Twitter / X: @coffeensecurity
- www.coffeeandsecurity.com
Daksh SCRA(Source Code Review Assist)は、ソースコードレビュープロセスの効率を高めるために構築されており、コードレビュー担当者に構造化され整理されたアプローチを提供します。
潜在的な問題をすべて無差別にフラグ付けするのではなく、Daksh SCRAは思慮深い分析を促進し、潜在的な問題の調査と確認を促します。このアプローチにより、あらゆる潜在的な懸念をバグとしてタグ付けしようと慌てることを軽減し、誤検知に費やす混乱と無駄な時間を削減します。
Daksh SCRAは当初、Black Hat USA 2022(8月6日〜9日)でのソースコードレビュートレーニングセッション中に、特定の聴衆に向けてさりげなく紹介されました。正式な一般公開は、ラスベガスで開催されたBlack Hat USA 2023で行われました。
DakshSCRAは、手動ソースコードレビューのための独自の機能を結集しています。ファイルパスの関心領域や工数見積もりから、ソフトウェア偵察、コンテキストルール、ファイル横断分析に至るまでをカバーします。
| 機能 | タグ | 重要な理由 |
|---|---|---|
| ファイルパスの関心領域 | 世界初* | コードと並行してファイル名やディレクトリ名自体をスキャンし、レビュー担当者が見落としがちなバックアップファイル、デバッグエンドポイント、設定ダンプ、認証情報ファイルなどの疑わしいパスをフラグ付けします。 |
| 科学的工数見積もり | 世界初* | コードベースの規模とプロジェクトのシグナルに基づいて、手動レビュー工数の定量化された見積もりを生成します。設定可能な前提条件により、エンゲージメント計画が明示的かつ再現可能になります。 |
| ソフトウェア偵察 | 世界で2番目* | スキャン前に、ファイルの内容とプロジェクト構造から言語、フレームワーク、インフラストラクチャを検出します。技術インベントリを自動ルール選択、セマンティック分析、レビュー計画に結び付けます。 |
| 高度なセマンティックおよびファイル横断分析 | リリース時点で最も高度なオープンソース* | 専用に構築された分析を用いて、サポート対象のファイル境界を越えてユーザー制御データをソースからシンクまで追跡します。高度な分析は2026年3月に元のRDLとともに提供されました。RDL v2は、ファイルをまたいだセマンティックルール評価を拡張します。 |
| 機能 / マイルストーン | 日付 | リリース | 根拠 / 範囲 |
|---|---|---|---|
| 初期ベータとファイルパスルール | 2022年10月22日 | v0.1-beta | 初期リリース。保持されているソースには専用のファイルパスルール一覧が含まれています。 |
| ソフトウェア偵察(公開された導入) | 2023年7月9日 | v0.3-beta | リリースノートで偵察が導入されています。それ以前のリポジトリコードは別個の実装根拠です。 |
| 手動レビュー工数見積もり(実装) | 2023年7月29日 | 実装コミット | 専用の見積もりモジュールが追加されました。後の修正リリースの日付ではありません。 |
| 元のRDLとファイル間の高度な分析 | 2026年3月2日 | v0.31-beta | 条件付きルールロジックと独立したファイル横断分析が同時に提供されました。リリース表示日は3月2日、公開タイムスタンプは2026年3月1日18:39 UTCです。 |
日付はリポジトリまたはリリースのマイルストーンを示します。
DakshSCRAはBlack Hat USA 2022のトレーニングで紹介され、Black Hat USA 2023で一般公開されました。これらの日付はプロジェクトの紹介時期を示すものであり、現在のすべての機能を示すものではありません。
積極的な機能強化が継続中です。今後のリリースでは、複数の新機能と改善が予定されています。
新しいルールの更新や追加、今後の開発への貢献を歓迎します。
バグを見つけた場合は、[email protected]までご報告ください。
詳細なドキュメント: https://dakshlabs.com/#docs
Daksh SCRAを実行する方法は2つあります。ワークフローに合った方を選んでください:
| 最適な用途 | ジャンプ先 | |
|---|---|---|
| 🌐 Web UI (Docker) | 最も簡単に始める方法 - コマンド1つ、ブラウザダッシュボード、ライブスキャン進捗、レポート/アーティファクトブラウザ。ほとんどのユーザーに推奨。 | Web UI (Docker) |
| 💻 CLI (Python) | スクリプト、CIパイプライン、またはDockerなしでのスキャン実行。 | CLIセットアップ |
どちらの方法もまったく同じスキャンエンジンを実行します - Web UIは同じCLIの上に構築されたブラウザフロントエンドであるため、どちらでも結果は同一です。
Daksh SCRAを実行する最速の方法は、ホスト対応のDocker起動ヘルパーで起動するブラウザベースのWeb UIを使用することです。スキャンランチャー、ライブコンソールフィード、過去のレポートを閲覧できる履歴が提供されます。起動ヘルパーにはPython 3が必要です(標準ライブラリのみ)。アプリケーションとその依存関係はDocker内で実行されます。
Dockerセットアップでは、Web UIとCLIを同じイメージからビルドされた独立したサービスとして実行するため、同じコンテナからどちらか(または両方)を使用できます。
GitHubからDaksh SCRAをダウンロードした後、まずZIPアーカイブを展開してください。
docker-compose.ymlとdakshscra.pyを含む展開済みの
プロジェクトフォルダ内でターミナル(WindowsではPowerShellまたはコマンドプロンプト)を開きます。
以下のすべての起動コマンドとDocker Composeコマンドは、そのフォルダから実行してください。
ターミナルが別の場所で開いた場合は、まず展開したフォルダに移動してください:
cd "path/to/extracted/DakshSCRA-folder"
例のパスを、実際のダウンロード場所とフォルダ名に置き換えてください。
代わりにリポジトリをクローンした場合は、その親フォルダから cd DakshSCRA を実行してください。
起動ヘルパーは Windows、WSL、Linux、macOS を認識し、コンテナを起動する前に ホストのルート、利用可能な Windows ドライブ、および一般的なフォルダを読み取り専用でマウントします。 Docker を実行しているコンピュータ上で実行してください。
Linux、macOS、または WSL(フォアグラウンド):
python3 tools/start_webui.py
Windows PowerShell またはコマンドプロンプト(フォアグラウンド):
py tools/start_webui.py
デタッチ(バックグラウンド)モードで実行するには、--detach を追加します。起動コマンドが戻った後もコンテナは実行し続け、ターミナルは利用可能なままになります。
Linux、macOS または WSL(デタッチ):
python3 tools/start_webui.py --detach
Windows PowerShell またはコマンドプロンプト(デタッチ):
py tools/start_webui.py --detach
--dry-run を使用すると、コンテナを起動せずに検出されたパスを確認できます。
既存の .env パスの上書き設定は尊重されます。アカウント、スキャン、ランタイム
ボリュームは、コンテナが再作成されても保持されます。
Docker Desktop では、選択したホストパスを共有するための権限が必要になる場合があります。マウントが 拒否された場合は、Docker Desktop でその場所を許可し、ヘルパーを再実行してください。 リモートブラウザには Docker ホストの フォルダが表示され、自身のコンピュータのドライブは表示されません。 自動検出にはローカルの Docker エンジンが必要です。リモートの Docker コンテキストを使用する場合は、 エンジンホスト上でヘルパーを実行してください。
手動で設定したマウントの場合、docker compose up --build -d api web は引き続き
利用できます。そのベースラインでは、リポジトリを /scan-targets に、
${DAKSH_HOST_MOUNT:-/} を /host/root にマウントします。Windows のドライブ検出
および共通フォルダのショートカットにはヘルパーを使用してください。通常の Compose ではクライアント OS を検出できません。
次に http://localhost:3030 を開きます。
別のポートを使用する場合:
DAKSH_PORT=9090 python3 tools/start_webui.py
スタックを停止するには:
docker compose down
リポジトリフォルダにある個別のクリーンアップヘルパーを使用してください。デフォルトではプレビューのみ実行されます:
これにより Daksh のコンテナ、サービスイメージ、ネットワーク、ボリュームが削除されます。これには保存されたアカウント、スキャン履歴、ランタイムボリュームに保存されたアーティファクトが含まれます。保持したいものは事前にバックアップしてください。
python3 tools/clean_project_docker.py
python3 tools/purge_all_docker.py
--execute を追加して削除を実行し、その後要求される確認を入力します。最初のヘルパーはこのプロジェクトのコンテナ、ネットワーク、サービスイメージ、ボリュームを削除し、共有ビルドキャッシュは保持します。2 番目のヘルパーは選択した Docker エンジン上のすべてのプロジェクトにわたってコンテナを強制的に削除し、イメージ、ネットワーク、名前付き/匿名ボリューム、デフォルトビルダーのキャッシュを prune します。リモートエンジンに影響を与える可能性があります。どちらもバインドマウントされたホストファイルを削除したり、Docker をアンインストールしたりしません。Windows ユーザーは python3 を py に置き換えることができます。カスタムプロジェクト名、除外、削除の詳細については クリーンアップの範囲とコマンド を参照してください。
残りの Docker ディスク使用量を確認するには:
docker system df
未使用のビルドキャッシュのみを解放し、保存済みの Daksh データを保持するには、docker builder prune --all --force を実行するだけです。リポジトリやスキャン対象を含む、バインドマウントされたホストフォルダ内のファイルはディスク上に残ります。準備ができたら python3 tools/start_webui.py --detach で再度起動してください。
Web UI にはアカウントが必要です。
初回ログイン
ポータルを起動し(python3 tools/start_webui.py --detach)、http://localhost:3030 を開きます。
ログインページが初回セットアップを検出します。ユーザー名 admin と初期パスワードが事前入力され、初回セットアップの通知が表示されます。
| 設定 | 値 |
|---|---|
| ユーザー名 | admin(または .env の DAKSH_ADMIN_USERNAME) |
| 初期パスワード | Daksh@ChangeMe1(または .env の DAKSH_ADMIN_PASSWORD) |
Sign in をクリックします。全画面のパスワード変更ステップが表示され、スキップできません。現在のパスワードとして初期パスワードを入力し、新しいパスワード(8文字以上、現在のものと異なること)を選択し、必要に応じてユーザー名を変更します。
保存後、ダッシュボードに移動します。以降、ログインページは何も事前入力しなくなり、自身の認証情報でサインインします。
初期パスワードはデータベースにアカウントが存在しない間のみ使用され、変更されるとすぐに機能しなくなります。それまでは、ポータルに到達できる誰もがこのパスワードでサインインできるため、ポータルが他の人から到達可能な場合は、初回起動前に .env で DAKSH_ADMIN_PASSWORD を設定してください。管理者アカウントは POST /api/v1/auth/users API エンドポイント経由で追加のアカウントを作成できます(これ専用の UI はまだありません)。新規アカウントおよびリセットされたアカウントも、初回ログイン時に割り当てられたパスワードを変更する必要があります。認証関連の設定(セッション有効期間、Cookie セキュリティ、CORS)の完全な一覧は .env.example を参照してください。
内部的には、CLI が引き続き信頼できる唯一の情報源です。スキャンをすべて実行し、すべての HTML / PDF / JSON 出力を生成します。Web UI は一度に1つのアクティブなジョブを実行し、完了した各ジョブの出力を runtime/webui/jobs/<job-id>/artifacts/ にスナップショットするため、過去のレポートに引き続きアクセスできます。
CLI を使用するためにローカルの Python 環境は必要ありません。同じイメージからビルドされた専用の Compose サービスとして利用できます。