mirror of
https://github.com/github/codeql.git
synced 2026-05-02 12:15:17 +02:00
Merge branch 'main' into changedocs/2.19.0
This commit is contained in:
Florin Coada
@@ -2,18 +2,33 @@
|
||||
|
||||
.. _about-codeql:
|
||||
|
||||
.. meta::
|
||||
:description: Introduction to CodeQL, a language and toolchain for code analysis.
|
||||
:keywords: CodeQL, code analysis, CodeQL analysis, security vulnerabilities, variant analysis, resources, tutorials, interactive training, GitHub Security Lab, security researchers, CodeQL databases
|
||||
|
||||
About CodeQL
|
||||
============
|
||||
|
||||
CodeQL is the analysis engine used by developers to automate security checks, and by
|
||||
security researchers to perform variant analysis.
|
||||
CodeQL is a language and toolchain for code analysis. It is designed to allow security researchers to scale their knowledge of a single vulnerability to identify variants of that vulnerability across a wide range of codebases. It is also designed to allow developers to automate security checks and integrate them into their development workflows.
|
||||
|
||||
In CodeQL, code is treated like data. Security vulnerabilities, bugs,
|
||||
and other errors are modeled as queries that can be executed against databases
|
||||
extracted from code. You can run the standard CodeQL queries, written by GitHub
|
||||
researchers and community contributors, or write your own to use in custom
|
||||
analyses. Queries that find potential bugs highlight the result directly in the
|
||||
source file.
|
||||
Resources for learning CodeQL
|
||||
-----------------------------
|
||||
|
||||
- **CodeQL docs site:** contains information on the CodeQL language and libraries, with tutorials and guides to help you learn how to write your own queries.
|
||||
|
||||
- :doc:`CodeQL queries <../writing-codeql-queries/codeql-queries>`: A general, language-neutral overview of the key components of a query.
|
||||
|
||||
- :doc:`QL tutorials <../writing-codeql-queries/ql-tutorials>`: Solve puzzles to learn the basics of QL before you analyze code with CodeQL. The tutorials teach you how to write queries and introduce you to key logic concepts along the way.
|
||||
|
||||
- :doc:`CodeQL language guides <../codeql-language-guides/index>`: Guides to the CodeQL libraries for each language, including the classes and predicates that are available for use in queries, with worked examples.
|
||||
|
||||
- **GitHub Security Lab:** is GitHub's own security research team. They've created a range of resources to help you learn how to use CodeQL to find security vulnerabilities in real-world codebases.
|
||||
|
||||
- `Secure code game <https://github.com/skills/secure-code-game>`__: A series of interactive sessions that guide you from finding insecure code patterns manually, through to using CodeQL to find insecure code patterns automatically.
|
||||
|
||||
- `Security Lab CTF <https://securitylab.github.com/ctf/>`__: A series of Capture the Flag (CTF) challenges that are designed to help you learn how to use CodeQL to find security vulnerabilities in real-world codebases.
|
||||
|
||||
- `Security Lab blog <https://github.blog/tag/github-security-lab/>`__: A series of blog posts that describe how CodeQL is used by security researchers to find security vulnerabilities in real-world codebases.
|
||||
|
||||
About variant analysis
|
||||
----------------------
|
||||
@@ -30,6 +45,8 @@ queries. Then, develop or iterate over the query to automatically find logical
|
||||
variants of the same bug that could be missed using traditional manual
|
||||
techniques.
|
||||
|
||||
When you have a query that finds variants of a vulnerability, you can use multi-repository variant analysis to run that query across a large number of codebases, and identify all of the places where that vulnerability exists. For more information, see `Running CodeQL queries at scale with multi-repository variant analysis <https://docs.github.com/en/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis>`__ in the GitHub docs.
|
||||
|
||||
CodeQL analysis
|
||||
---------------
|
||||
|
||||
@@ -39,11 +56,13 @@ CodeQL analysis consists of three steps:
|
||||
#. Running CodeQL queries against the database
|
||||
#. Interpreting the query results
|
||||
|
||||
For information on the CodeQL toolchain and on running CodeQL to analyze a codebase, see the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__, `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code>`__, and `About code scanning with CodeQL <https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql>`__ in the GitHub docs.
|
||||
|
||||
Database creation
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
To create a database, CodeQL first extracts a single relational representation
|
||||
of each source file in the codebase.
|
||||
of each source file in the codebase.
|
||||
|
||||
For compiled languages, extraction works by monitoring the normal build process.
|
||||
Each time a compiler is invoked to process a source file, a copy of that file is
|
||||
@@ -52,7 +71,7 @@ syntactic data about the abstract syntax tree and semantic data about name
|
||||
binding and type information.
|
||||
|
||||
For interpreted languages, the extractor runs directly on the source code,
|
||||
resolving dependencies to give an accurate representation of the codebase.
|
||||
resolving dependencies to give an accurate representation of the codebase.
|
||||
|
||||
There is one :ref:`extractor <extractor>` for each language supported by CodeQL
|
||||
to ensure that the extraction process is as accurate as possible. For
|
||||
@@ -72,7 +91,7 @@ against it. CodeQL queries are written in a specially-designed object-oriented
|
||||
query language called QL. You can run the queries checked out from the CodeQL
|
||||
repo (or custom queries that you've written yourself) using the `CodeQL
|
||||
for VS Code extension <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ or the `CodeQL CLI
|
||||
<https://docs.github.com/en/code-security/codeql-cli>`__. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`."
|
||||
<https://docs.github.com/en/code-security/codeql-cli>`__. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`."
|
||||
|
||||
.. _interpret-query-results:
|
||||
|
||||
@@ -95,7 +114,7 @@ code.
|
||||
Following interpretation, results are output for code review and triaging. In
|
||||
CodeQL for Visual Studio Code, interpreted query results are automatically
|
||||
displayed in the source code. Results generated by the CodeQL CLI can be output
|
||||
into a number of different formats for use with different tools.
|
||||
into a number of different formats for use with different tools.
|
||||
|
||||
|
||||
About CodeQL databases
|
||||
@@ -104,7 +123,7 @@ About CodeQL databases
|
||||
CodeQL databases contain queryable data extracted from a codebase, for a single
|
||||
language at a particular point in time. The database contains a full,
|
||||
hierarchical representation of the code, including a representation of the
|
||||
abstract syntax tree, the data flow graph, and the control flow graph.
|
||||
abstract syntax tree, the data flow graph, and the control flow graph.
|
||||
|
||||
Each language has its own unique database schema that defines the relations used
|
||||
to create a database. The schema provides an interface between the initial
|
||||
@@ -114,13 +133,13 @@ every language construct.
|
||||
|
||||
For each language, the CodeQL libraries define classes to provide a layer of
|
||||
abstraction over the database tables. This provides an object-oriented view of
|
||||
the data which makes it easier to write queries.
|
||||
the data which makes it easier to write queries.
|
||||
|
||||
For example, in a CodeQL database for a Java program, two key tables are:
|
||||
|
||||
- The ``expressions`` table containing a row for every single expression in the
|
||||
source code that was analyzed during the build process.
|
||||
- The ``statements`` table containing a row for every single statement in the
|
||||
source code that was analyzed during the build process.
|
||||
- The ``statements`` table containing a row for every single statement in the
|
||||
source code that was analyzed during the build process.
|
||||
|
||||
The CodeQL library defines classes to provide a layer of abstraction over each
|
||||
|
||||
@@ -5,17 +5,16 @@
|
||||
CodeQL tools
|
||||
============
|
||||
|
||||
GitHub provides the CodeQL command-line interface and CodeQL for Visual Studio
|
||||
Code for performing CodeQL analysis on open source codebases.
|
||||
GitHub provides the CodeQL command-line interface and CodeQL for Visual Studio Code for performing CodeQL analysis on open source codebases. For information on the use cases for each tool, see ":ref:`Running CodeQL queries <running-codeql-queries>`."
|
||||
|
||||
CodeQL command-line interface
|
||||
-----------------------------
|
||||
|
||||
The CodeQL command-line interface (CLI) is primarily used to create databases for
|
||||
security research. You can also query CodeQL databases directly from the command line
|
||||
The CodeQL command-line interface (CLI) is primarily used to create databases for
|
||||
security research. You can also query CodeQL databases directly from the command line
|
||||
or using the Visual Studio Code extension.
|
||||
The CodeQL CLI can be downloaded from `GitHub releases <https://github.com/github/codeql-cli-binaries/releases>`__.
|
||||
For more information, see "`CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__" and the `CLI changelog <https://github.com/github/codeql-cli-binaries/blob/main/CHANGELOG.md>`__.
|
||||
The CodeQL CLI can be downloaded from "`GitHub releases <https://github.com/github/codeql-cli-binaries/releases>`__."
|
||||
For more information, see "`CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__" and the ":ref:`Change log <codeql-changes>`."
|
||||
|
||||
CodeQL packs
|
||||
-----------------------------
|
||||
@@ -38,15 +37,15 @@ maintained by GitHub are:
|
||||
- ``codeql/python-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/python/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/python/ql/lib>`__)
|
||||
- ``codeql/ruby-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/src>`__)
|
||||
- ``codeql/ruby-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/lib>`__)
|
||||
- ``codeql/swift-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/src>`__)
|
||||
- ``codeql/swift-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/lib>`__)
|
||||
|
||||
For more information, see "`About CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs>`__."
|
||||
|
||||
CodeQL bundle
|
||||
-----------------------------
|
||||
|
||||
The CodeQL bundle consists of the CodeQL CLI together with the standard CodeQL query and library packs
|
||||
maintained by GitHub. The bundle can be downloaded from `GitHub releases <https://github.com/github/codeql-action/releases>`__.
|
||||
Use this when running `code scanning with CodeQL <https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql>`__ on GitHub Actions or in another CI system.
|
||||
The CodeQL bundle consists of the CodeQL CLI together with the standard CodeQL query and library packs maintained by GitHub. The bundle is used by the CodeQL action in GitHub to generate code scanning results. If you use an external CI system, you can download the bundle from `GitHub releases <https://github.com/github/codeql-action/releases>`__, generate code scanning results, and upload them to GitHub.
|
||||
|
||||
CodeQL for Visual Studio Code
|
||||
-----------------------------
|
||||
@@ -54,4 +53,4 @@ CodeQL for Visual Studio Code
|
||||
You can analyze CodeQL databases in Visual Studio Code using the CodeQL
|
||||
extension, which provides an enhanced environment for writing and running custom
|
||||
queries and viewing the results. For more information, see "`CodeQL
|
||||
for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__."
|
||||
for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__."
|
||||
|
||||
Reference in New Issue
Block a user