Skip to main content

GitHubから CodeQL データベースをダウンロードする

既製のデータベースを追加して、CodeQL CLI の対象範囲を拡大します。

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

  • GitHub.com のパブリック リポジトリについては、「GitHub CodeQL の使用条件」を参照してください
  • GitHub Code Security が有効になっている GitHub Team または GitHub Enterprise Cloud 上の organization 所有のリポジトリ

GitHub では、REST API を使用してダウンロードできる 200,000 を超えるリポジトリの CodeQL データベースを GitHub.com に保存しています。 リポジトリの一覧は、セキュリティ調査のための最も興味深いコードベースが確実に含まれるように、絶えず増加し、進化しています。

データベースの検索

          `/repos/OWNER/REPOSITORY/code-scanning/codeql/databases` エンドポイントを使用して、リポジトリにダウンロード可能な CodeQL データベースがあるかどうかを確認できます。 
          [GitHub CLI](https://cli.github.com/manual/gh_api) を使用して CodeQL データベースを確認するには、次のコマンドを実行します。
gh api /repos/OWNER/REPOSITORY/code-scanning/codeql/databases

このコマンドからは、リポジトリで使用できる CodeQL データベースに関する情報が返されます。データベースが表す言語や、データベースが最後に更新された日時などです。 使用できる CodeQL データベースがない場合、応答は空です。

データベースのダウンロード

目的の言語の CodeQL データベースが存在することを確認したら、次のコマンドを使用してダウンロードできます。

gh api /repos/OWNER/REPOSITORY/code-scanning/codeql/databases/LANGUAGE -H 'Accept: application/zip' > LOCAL-DATABASE-FILE.zip

詳しくは、「CodeQL データベース エンドポイントの取得」のドキュメントを参照してください。

CodeQL CLI を使用して分析を実行する前に、データベースを解凍する必要があります。

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

VS Code 拡張機能の CodeQL を使用して、GitHub.com からデータベースを分析することもできます。 詳しくは、「CodeQL クエリの実行」をご覧ください。