AdvancedSecurity-Codeql-Analyze@1 - Advanced Security Perform CodeQL analysis v1 task

[アーティクル]
04/29/2024

Azure Repos Git リポジトリ内のコードを分析して、セキュリティの脆弱性とコーディングエラーを見つけます。スキャン対象のリポジトリに対して Azure DevOps のGitHub Advanced Securityが有効になっている必要があります。

構文

# Advanced Security Perform CodeQL analysis v1
# Finalizes the CodeQL database and runs the analysis queries.
- task: AdvancedSecurity-Codeql-Analyze@1
  inputs:
    #WaitForProcessing: false # boolean. Enable Wait for Processing. Default: false.
    #WaitForProcessingInterval: '5' # string. Optional. Use when WaitForProcessing = true. Wait for Processing Time Interval. Default: 5.
    #WaitForProcessingTimeout: '120' # string. Optional. Use when WaitForProcessing = true. Wait for Processing Timeout. Default: 120.

入力

WaitForProcessing - 処理の待機を有効にする
boolean. 既定値: false。

完了する前に、Advanced Security が発行された SARIF ファイルを処理するまで待ちます。

WaitForProcessingInterval - 処理時間間隔の待機
string. 省略可能。の場合は WaitForProcessing = trueを使用します。既定値: 5。

ADVANCED Security の各呼び出しから SARIF 処理状態をチェックするまで待機する時間 (秒単位)。

WaitForProcessingTimeout - 処理タイムアウトの待機
string. 省略可能。の場合は WaitForProcessing = trueを使用します。既定値: 120。

完了する前に Advanced Security が SARIF ファイルを処理するまで待機する時間 (秒単位)。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。詳細については、「コントロールオプションと一般的なタスクプロパティ」を参照してください。

出力変数

[なし] :

解説

重要

このタスクは、Azure Repos Git リポジトリでのみサポートされています。

前提条件

タスクが正常に完了し、スキャンされたリポジトリの [Advanced Security]\(高度なセキュリティ\) タブに入力するには、依存関係スキャンタスクを含むビルドを実行する前に、そのリポジトリに対して Advanced Security を有効にする必要があります。

このタスクは、セルフホステッドエージェントと Microsoft ホステッドエージェントで実行できます。セルフホステッドエージェントについては、その他のセルフホステッドエージェントのセットアップ手順に関するページを参照してください。

パイプラインは、次の順序でタスクを呼び出す必要があります。

Initialize CodeQL
AutoBuild (またはカスタムビルドタスク)
CodeQL 分析を実行する

AutoBuild タスクは省略可能であり、カスタムビルドタスクに置き換えることができます。プロジェクトを分析するには、AutoBuild またはカスタムビルドタスクを実行する必要があります。

正常に完了するには、初期化タスクの後に分析タスクを表示する必要があります。

# Initialize CodeQL database 
- task: AdvancedSecurity-Codeql-Init@1
  inputs: 
    language: csharp 
  displayName: 'Advanced Security Initialize CodeQL' 

# Build project using Autobuild or your own custom build steps 
- task: AdvancedSecurity-Codeql-Autobuild@1
  displayName: 'Advanced Security Autobuild' 

# Run analysis 
- task: AdvancedSecurity-Codeql-Analyze@1 
  displayName: 'Advanced Security Code Scanning'

要件

要件	説明
パイプラインの種類	YAML、クラシックビルド、クラシックリリース
実行日	エージェント、DeploymentGroup
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	サポートされているすべてのエージェントバージョン。
タスクのカテゴリ	Build

こちらもご覧ください

GitHub Advanced Securityのコードスキャン