hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

JS: Add deprecation notice to page about JSON-based format

Browse Source
This commit is contained in:
Asger F
2022-12-09 12:51:46 +01:00
parent 9ce0c60247
commit 111cabbfc1
3 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/codeql/codeql-language-guides/codeql-for-javascript.rst
View File

@@ -29,8 +29,6 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
- :doc:`Using flow labels for precise data flow analysis <using-flow-labels-for-precise-data-flow-analysis>`: You can associate flow labels with each value tracked by the flow analysis to determine whether the flow contains potential vulnerabilities.
- :doc:`Specifying remote flow sources for JavaScript <specifying-additional-remote-flow-sources-for-javascript>`: You can model potential sources of untrusted user input in your code without making changes to the CodeQL standard library by specifying extra remote flow sources in an external file.
- :doc:`Customizing library models for JavaScript <customizing-library-models-for-javascript>`: You can model the libraries used in your code without making changes to the CodeQL standard library by specifying source, sink, and flow summaries in a data extension file.
- :doc:`Using type tracking for API modeling <using-type-tracking-for-api-modeling>`: You can track data through an API by creating a model using the CodeQL type-tracking library for JavaScript.

2
docs/codeql/codeql-language-guides/customizing-library-models-for-javascript.rst
View File

@@ -1,4 +1,4 @@
.. \_customizing-library-models-for-javascript:
.. _customizing-library-models-for-javascript:
Customizing Library Models for JavaScript
=========================================

11
docs/codeql/codeql-language-guides/specifying-additional-remote-flow-sources-for-javascript.rst
View File

@@ -3,13 +3,16 @@
Specifying additional remote flow sources for JavaScript
========================================================
You can model potential sources of untrusted user input in your code without making changes to the CodeQL standard library by specifying extra remote flow sources in an external file.
.. pull-quote::
Note
Deprecation Notice
Specifying remote flow sources in external files is currently in beta and subject to change.
Specifying remote flow sources with the JSON format described here is soon to be deprecated
and will be removed in the future.
See :ref:`Customizing Library Models for JavaScript <customizing-library-models-for-javascript>`.
You can model potential sources of untrusted user input in your code without making changes to the CodeQL standard library by specifying extra remote flow sources in an external file.
As mentioned in the :ref:`Data flow cheat sheet for JavaScript <data-flow-cheat-sheet-for-javascript--untrusted-data>`, the CodeQL libraries for JavaScript
provide a class `RemoteFlowSource <https://codeql.github.com/codeql-standard-libraries/javascript/semmle/javascript/security/dataflow/RemoteFlowSources.qll/type.RemoteFlowSources$Cached$RemoteFlowSource.html>`__ to represent sources of untrusted user input, sometimes also referred to as remote flow