注: この機能を使うには、サイト管理者が お使いの GitHub Enterprise Server インスタンス の code scanning を有効にする必要があります。 詳しくは、「アプライアンスのコードスキャンを設定する」を参照してください。
Enterprise の所有者が Enterprise レベルで GitHub Advanced Security (GHAS) ポリシーを設定している場合、code scanning を有効または無効にできない場合があります。 詳しくは、「エンタープライズのコード セキュリティと分析のためのポリシーの適用」を参照してください。
About code scanning with CodeQL
CodeQL は、セキュリティ チェックを自動化するために GitHub が開発した、コード分析エンジンです。 CodeQL を使用してコードを分析し、結果を code scanning アラートとして表示することができます。
There are two main ways to use CodeQL analysis for code scanning:
-
Add the CodeQL workflow to your repository. This uses the github/codeql-action to run the CodeQL CLI. For more information, see "About code scanning with CodeQL."
-
Run the CodeQL CLI directly in an external CI system and upload the results to GitHub. For more information, see "CIシステムでのCodeQL Code scanningについて."
For information about code scanning alerts, see "Code scanningアラートについて."
About CodeQL
CodeQL treats code like data, allowing you to find potential vulnerabilities in your code with greater confidence than traditional static analyzers.
- You generate a CodeQL database to represent your codebase.
- Then you run CodeQL queries on that database to identify problems in the codebase.
- The query results are shown as code scanning alerts in GitHub Enterprise Server when you use CodeQL with code scanning.
CodeQL supports both compiled and interpreted languages, and can find vulnerabilities and errors in code that's written in the supported languages.
- C/C++
- C#
- Go
- Java
- JavaScript/TypeScript
- Python
- Ruby
注:
- Ruby の CodeQL 分析は、現在ベータ版です。 ベータ版の間、Ruby の分析は他の言語の CodeQL 分析ほど包括的ではありません。
- JavaScript、TypeScript、またはその両方で記述されたコードを分析するには
javascript
を使用します。
詳細については、CodeQL Web サイトのドキュメント「サポートされている言語とフレームワーク」を参照してください。
About CodeQL queries
GitHub experts, security researchers, and community contributors write and maintain the default CodeQL queries used for code scanning. The queries are regularly updated to improve analysis and reduce any false positive results. The queries are open source, so you can view and contribute to the queries in the github/codeql
repository. For more information, see CodeQL on the CodeQL website. You can also write your own queries. For more information, see "About CodeQL queries" in the CodeQL documentation.
If you are scanning your code with advanced setup or an external CI system, you can run additional queries as part of your analysis.
The queries you want to run must belong to a QL pack in a repository. Queries must only depend on the standard libraries (that is, the libraries referenced by an import LANGUAGE
statement in your query), or libraries in the same QL pack as the query.