зеркало из https://github.com/github/codeql.git
docs: further reading for codeql queries section
This commit is contained in:
Родитель
29eed6866c
Коммит
5292051c3e
|
@ -79,8 +79,7 @@ However, since ``y`` is derived from ``x``, it is influenced by the untrusted or
|
||||||
In QL, taint tracking extends data flow analysis by including steps in which the data values are not necessarily preserved, but the potentially insecure object is still propagated.
|
In QL, taint tracking extends data flow analysis by including steps in which the data values are not necessarily preserved, but the potentially insecure object is still propagated.
|
||||||
These flow steps are modeled in the taint-tracking library using predicates that hold if taint is propagated between nodes.
|
These flow steps are modeled in the taint-tracking library using predicates that hold if taint is propagated between nodes.
|
||||||
|
|
||||||
What next?
|
Further reading
|
||||||
**********
|
***************
|
||||||
|
|
||||||
- Search for ``DataFlow`` and ``TaintTracking`` in the `standard CodeQL libraries <https://help.semmle.com/QL/ql-libraries.html>`__ to learn more about the technical implementation of data flow analysis for specific programming languages.
|
- `Exploring data flow with path queries <https://help.semmle.com/codeql/codeql-for-vscode/procedures/exploring-paths.html>`__
|
||||||
- Visit `Learning CodeQL <https://help.semmle.com/QL/learn-ql/>`__ to find language-specific tutorials on data flow and other topics.
|
|
||||||
|
|
|
@ -115,3 +115,8 @@ The ``toString()`` predicate
|
||||||
----------------------------
|
----------------------------
|
||||||
|
|
||||||
All classes except those that extend primitive types, must provide a ``string toString()`` member predicate. The query compiler will complain if you don't. The uniqueness warning, noted above for locations, applies here too.
|
All classes except those that extend primitive types, must provide a ``string toString()`` member predicate. The query compiler will complain if you don't. The uniqueness warning, noted above for locations, applies here too.
|
||||||
|
|
||||||
|
Further reading
|
||||||
|
---------------
|
||||||
|
|
||||||
|
- `CodeQL repository <https://github.com/github/codeql>`__
|
|
@ -151,4 +151,4 @@ Now the structure we want is clearer. We've separated out the easy part into its
|
||||||
Further information
|
Further information
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
- Find out more about QL in the `QL language reference <https://help.semmle.com/QL/ql-handbook/index.html>`__.
|
.. include:: ../../reusables/codeql-ref-tools-further-reading.rst
|
||||||
|
|
|
@ -150,12 +150,3 @@ Query help files
|
||||||
****************
|
****************
|
||||||
|
|
||||||
When you write a custom query, we also recommend that you write a query help file to explain the purpose of the query to other users. For more information, see the `Query help style guide <https://github.com/github/codeql/blob/master/docs/query-help-style-guide.md>`__ on GitHub, and the :doc:`Query help files <query-help>`.
|
When you write a custom query, we also recommend that you write a query help file to explain the purpose of the query to other users. For more information, see the `Query help style guide <https://github.com/github/codeql/blob/master/docs/query-help-style-guide.md>`__ on GitHub, and the :doc:`Query help files <query-help>`.
|
||||||
|
|
||||||
What next?
|
|
||||||
==========
|
|
||||||
|
|
||||||
- See the queries used in real-life variant analysis on the `GitHub Security Lab website <https://securitylab.github.com/research>`__.
|
|
||||||
- To learn more about writing path queries, see :doc:`Creating path queries <path-queries>`.
|
|
||||||
- Take a look at the `built-in queries <https://help.semmle.com/wiki/display/QL/Built-in+queries>`__ to see examples of the queries included in CodeQL.
|
|
||||||
- Explore the `query cookbooks <https://help.semmle.com/wiki/display/QL/QL+cookbooks>`__ to see how to access the basic language elements contained in the CodeQL libraries.
|
|
||||||
- For a full list of resources to help you learn CodeQL, including beginner tutorials and language-specific examples, visit `Learning CodeQL <https://help.semmle.com/QL/learn-ql/>`__.
|
|
||||||
|
|
|
@ -189,9 +189,8 @@ The ``element`` that you select in the first column depends on the purpose of th
|
||||||
|
|
||||||
The alert message defined in the final column in the ``select`` statement can be developed to give more detail about the alert or path found by the query using links and placeholders. For more information, see :doc:`Defining the results of a query <select-statement>`.
|
The alert message defined in the final column in the ``select`` statement can be developed to give more detail about the alert or path found by the query using links and placeholders. For more information, see :doc:`Defining the results of a query <select-statement>`.
|
||||||
|
|
||||||
What next?
|
Further reading
|
||||||
**********
|
***************
|
||||||
|
|
||||||
- Take a look at the path queries for `C/C++ <https://help.semmle.com/wiki/label/CCPPOBJ/path-problem>`__, `C# <https://help.semmle.com/wiki/label/CSHARP/path-problem>`__, `Java <https://help.semmle.com/wiki/label/java/path-problem>`__, `JavaScript <https://help.semmle.com/wiki/label/js/path-problem>`__, and `Python <https://help.semmle.com/wiki/label/python/path-problem>`__ to see examples of these queries.
|
- `Exploring data flow with path queries <https://help.semmle.com/codeql/codeql-for-vscode/procedures/exploring-paths.html>`__
|
||||||
- Explore the `query cookbooks <https://help.semmle.com/wiki/display/QL/QL+cookbooks>`__ to see how to access the basic language elements contained in the CodeQL libraries.
|
- `CodeQL repository <https://github.com/github/codeql>`__
|
||||||
- For a full list of resources to help you learn CodeQL, including beginner tutorials and language-specific examples, visit `Learning CodeQL <https://help.semmle.com/QL/learn-ql/>`__.
|
|
||||||
|
|
|
@ -206,8 +206,3 @@ The included file, `ThreadUnsafeICryptoTransformOverview.qhelp <https://github.
|
||||||
</fragment>
|
</fragment>
|
||||||
</qhelp>
|
</qhelp>
|
||||||
|
|
||||||
Further information
|
|
||||||
===================
|
|
||||||
|
|
||||||
- To learn more about contributing to the standard CodeQL queries and libraries, see our `Contributing guidelines <https://github.com/github/codeql/blob/master/CONTRIBUTING.md>`__ on GitHub.
|
|
||||||
- To learn more about writing custom queries, and how to format your code for clarity and consistency, see `Writing CodeQL queries <https://help.semmle.com/QL/learn-ql/writing-queries/writing-queries.html>`__.
|
|
||||||
|
|
|
@ -99,7 +99,3 @@ Here is the metadata for one of the standard Java queries:
|
||||||
.. |image0| image:: ../../images/query-metadata.png
|
.. |image0| image:: ../../images/query-metadata.png
|
||||||
|
|
||||||
For more examples of query metadata, see the standard CodeQL queries in our `GitHub repository <https://github.com/github/codeql>`__.
|
For more examples of query metadata, see the standard CodeQL queries in our `GitHub repository <https://github.com/github/codeql>`__.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -105,3 +105,8 @@ The new elements added here don't need to be clickable, so we added them directl
|
||||||
.. image:: ../../images/ql-select-statement-similarity.png
|
.. image:: ../../images/ql-select-statement-similarity.png
|
||||||
:alt: Results showing the extent of similarity
|
:alt: Results showing the extent of similarity
|
||||||
:class: border
|
:class: border
|
||||||
|
|
||||||
|
Further reading
|
||||||
|
---------------
|
||||||
|
|
||||||
|
- `CodeQL repository <https://github.com/github/codeql>`__
|
Загрузка…
Ссылка в новой задаче