mirror of
https://github.com/github/codeql.git
synced 2025-12-16 16:53:25 +01:00
JavaScript: Move flow summaries to experimental.
Also update description and change note to call out their experimental character more clearly.
This commit is contained in:
@@ -19,6 +19,8 @@
|
||||
- Calls can now be resolved to indirectly-defined class members in more cases.
|
||||
- Calls through partial invocations such as `.bind` can now be resolved in more cases.
|
||||
|
||||
* Support for flow summaries has been more clearly marked as being experimental and moved to the new `experimental` folder.
|
||||
|
||||
* Support for the following frameworks and libraries has been improved:
|
||||
- [Electron](https://electronjs.org/)
|
||||
- [Handlebars](https://www.npmjs.com/package/handlebars)
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
+ semmlecode-javascript-queries/Security/Summaries/ExtractSourceSummaries.ql
|
||||
+ semmlecode-javascript-queries/Security/Summaries/ExtractSinkSummaries.ql
|
||||
+ semmlecode-javascript-queries/experimental/Summaries/ExtractSourceSummaries.ql
|
||||
+ semmlecode-javascript-queries/experimental/Summaries/ExtractSinkSummaries.ql
|
||||
|
||||
@@ -14,6 +14,10 @@ added as external data), and are picked up by the standard security queries, all
|
||||
about flow into, out of and through the npm packages as though they had been included as part of the
|
||||
build.
|
||||
|
||||
Note that flow summaries are an experimental technology, and not ready to be used in production
|
||||
queries or libraries. Also note that flow summaries do not currently work with CodeQL, but require
|
||||
the legacy Semmle Core toolchain.
|
||||
|
||||
Motivating example
|
||||
------------------
|
||||
|
||||
@@ -87,11 +91,11 @@ package. (Note that this requires a working installation of Semmle Core.)
|
||||
There are three default summary extraction queries:
|
||||
|
||||
- Extract flow step summaries (``js/step-summary-extraction``,
|
||||
``Security/Summaries/ExtractSourceSummaries.ql``)
|
||||
``experimental/Summaries/ExtractSourceSummaries.ql``)
|
||||
- Extract sink summaries (``js/sink-summary-extraction``,
|
||||
``Security/Summaries/ExtractSinkSummaries.ql``)
|
||||
``experimental/Summaries/ExtractSinkSummaries.ql``)
|
||||
- Extract source summaries (``js/source-summary-extraction``,
|
||||
``Security/Summaries/ExtractSourceSummaries.ql``)
|
||||
``experimental/Summaries/ExtractSourceSummaries.ql``)
|
||||
|
||||
You can run these queries individually against a snapshot of the npm package you want to create
|
||||
flow summaries for using ``odasa runQuery``, and store the output as CSV files named
|
||||
@@ -103,7 +107,7 @@ project, we can extract sink summaries using the command
|
||||
.. code-block:: bash
|
||||
|
||||
odasa runQuery \
|
||||
--query $SEMMLE_DIST/queries/semmlecode-javascript-queries/Security/Summaries/ExtractSinkSummaries.ql \
|
||||
--query $SEMMLE_DIST/queries/semmlecode-javascript-queries/experimental/Summaries/ExtractSinkSummaries.ql \
|
||||
--output-file additional-sinks.csv --snapshot mkdirp-snapshot
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
Security/Summaries/ExtractFlowStepSummaries.ql
|
||||
experimental/Summaries/ExtractFlowStepSummaries.ql
|
||||
|
||||
@@ -1 +1 @@
|
||||
Security/Summaries/ExtractSinkSummaries.ql
|
||||
experimental/Summaries/ExtractSinkSummaries.ql
|
||||
|
||||
@@ -1 +1 @@
|
||||
Security/Summaries/ExtractSourceSummaries.ql
|
||||
experimental/Summaries/ExtractSourceSummaries.ql
|
||||
|
||||
Reference in New Issue
Block a user