プレビューに参加してください!
Code Analysis はプレビュー版です。
Code Analysis は サイトでは利用できません。
概要
Static Analysis (SAST) は、プログラムを実行する必要がない状態で、本番前段階のコードを分析するクリアボックス型のソフトウェアテスト手法です。つまり、プログラムが実行されていないため「スタティック (静的)」です。
Static Analysis は、ソフトウェア開発ライフサイクル (SDLC) の早期段階で保守性の問題やセキュリティ脆弱性を特定するのに役立ち、本番環境に到達するコードが最高水準の品質とセキュリティを備えるようにします。セキュリティ脆弱性をスキャンする Static Analysis ツールは、Static Application Security Testing (SAST) ツールとも呼ばれます。
Static Analysis を使用することにより、組織には以下のような利点があります。
- Static Analysis は、組織のコード標準に準拠するためのあいまいさを排除し、開発チームが開発速度に大きな影響を与えることなくコンプライアンスを満たしたコードをリリースできるようにします。
- 組織のアプリケーションは、SAST スキャンによって新たな脆弱性が本番環境に到達する前に捕捉されるため、長期的にセキュリティ侵害に対して脆弱である可能性が低くなります。
- Static Analysis により組織では長期的により可読性の高いコードベースが維持されるため、組織に参加したばかりの新しい開発者はより迅速にオンボーディングできます。
- 組織のソフトウェアは、コードの保守性が高まることによって長期的に信頼性が高まり、開発者が新たな欠陥をコードに導入するリスクが最小化されます。
Static Analysis のセットアップ
Static Analysis は、以下の言語およびテクノロジーで、望ましくないコーディング手法やセキュリティ脆弱性をスキャンすることをサポートします。
開始するには、Code Analysis ページで Static Analysis をセットアップするか、セットアップドキュメントを参照してください。
Static Analysis をソフトウェア開発ライフサイクルに統合する
CI プロバイダー
任意の CI プラットフォームプロバイダーで Static Analysis を実行できます。CI パイプラインで Static Analysis を設定するためのプロバイダー固有のドキュメントを参照してください。
ソースコード管理
GitHub 上のコードレビュー時に、Datadog はプルリクエスト内で該当するコード行にインラインレビューコメントを追加することで、Static Analysis 違反を自動的にフラグ付けできます。該当する場合、Datadog はプルリクエスト内で直接適用可能な修正案も提供します。また、Datadog から直接プルリクエストを開いて、脆弱性や品質上の問題を修正することもできます。
IDE
統合開発環境 (IDE) 内でファイルを編集しながら、リアルタイムでコードの脆弱性を特定できます。詳細については、インテグレーション固有のドキュメントを参照してください。
結果の検索とフィルタリング
Datadog Static Analyzer を実行するよう CI パイプラインを構成した後、違反事項は Code Analysis Repositories ページでリポジトリごとに要約されます。リポジトリをクリックすると、Static Analysis による Code Vulnerabilities および Code Quality の結果を分析できます。
結果をフィルタリングするには、リストの左側にあるファセットを使用するか、検索を利用してください。結果はサービスまたはチームファセットでフィルタリングできます。結果が Datadog サービスおよびチームにどのようにリンクされているかについては、Code Analysis の概要を参照してください。
各行は 1 件の違反事項を表しています。各違反事項は、ページのトップのフィルターで選択された特定のコミットおよびブランチに関連付けられています (デフォルトでは、表示中のリポジトリのデフォルトブランチの最新コミットの結果が表示されます)。
違反事項をクリックすると、違反事項の範囲や発生元に関する情報を含むサイドパネルが開きます。
違反事項の内容はタブで表示されます。
- Details: 違反事項の説明と、それを引き起こしたコード行が表示されます。不正なコードスニペットを表示するには、Datadog GitHub App を構成してください。
- Remediation: 違反事項を解消できる 1 つ以上のコード修正案が表示され、修正オプションを選択できます。
- Event: Static Analysis 違反イベントに関する JSON メタデータが表示されます。
提案修正の使用
Datadog Static Analysis では、2 種類の提案修正があります。
- Default Suggested Fix: リンティング問題のような単純な違反に対して、ルールアナライザーがあらかじめ定型化された修正案を自動的に提供します。
- AI Suggested Fix: より複雑な違反については、事前に修正が利用できないことが多いため、AI Suggested Fixes を使用できます。これは、OpenAI の GPT-4 を用いて修正案を生成します。「Text」および「Unified Diff」の 2 種類を選択でき、それぞれプレーンテキストの指示またはコード変更として修正案を出力します。
これら 2 種類の修正案は、UI 上で異なるラベルによって視覚的に区別されます。
Default Suggested Fixes:
AI Suggested Fixes:
AI Suggested Fixes はプレビュー版です。アクセスをリクエストするには、
サポートにお問い合わせください。
Datadog から直接脆弱性や品質上の問題を修正する
Code Analysis で検出された問題を、Datadog 上の結果から直接コード変更をプッシュして修正するには、2 つの方法があります。
プルリクエストを開く場合
GitHub App の Pull Requests パーミッションが Read & Write に設定されている場合、利用可能な修正提案があるすべての Static Analysis 結果に対してワンクリック修正が有効になります。GitHub インテグレーションの設定方法については GitHub プルリクエストを参照してください。
脆弱性を修正し、プルリクエストを開くには次の手順に従います。
- Code Analysis で特定の結果を表示します。
- 結果のサイドパネルで Fix Violation をクリックします。
- Open a Pull Request を選択します。
- プルリクエストタイトルとコミットメッセージを入力します。
- Create PR をクリックします。
現在のブランチに直接コミットする場合
また、結果が検出されたブランチに直接コミットして脆弱性を修正することもできます。
提案修正をコミットするには
- Code Analysis で特定の結果を表示します。
- 結果のサイドパネルで Fix Violation をクリックします。
- Commit to current branch をクリックします。
構成のカスタマイズ
リポジトリで構成される Static Analysis ルールをカスタマイズするには、セットアップドキュメントを参照してください。
誤検出の報告
特定の違反が誤検出であると思われる場合は、誤検出としてフラグを立てることができます。この場合、フラグを立てる理由とともに、Datadog にレポートが送信されます。ルールセット品質を向上させるために、送信内容は定期的にレビューされます。
その他の参考資料