Skip to content

Commit 74d3ae5

Browse files
authored
Clarify audit vs synthetic configs
1 parent bbb2862 commit 74d3ae5

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

configs/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,18 @@ The `default.yml` configuration is the default config file used to make it easy
66

77
## [Audit](audit.yml)
88

9-
The `audit.yml` configuration is used primary to audit code by running a number of audit queries with CodeQL.
9+
The `audit.yml` configuration is used primary to audit code by running a number of audit queries with CodeQL. Many queries here will be executed using partial path queries - not looking for full source/sink flows. Use these very broad queries or even [partial flow paths](https://codeql.github.com/docs/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow/) to help deduce where the taint might be breaking and to discover areas for potential customization enhancement.
10+
1011
These are based on the suite in each language suites folder called `{LANG}-audit.qls`
1112

1213
> [!NOTE]
1314
> Current Ruby and Swift are not supported
1415
1516
## [Synthetics](synthetics.yml)
1617

17-
This `synthetics.yml` configuration is intended for analyzing synthetic code samples. This configuration uses all possible queries from the CodeQL built in packs, the CodeQL Community Packs, and additional OSS queries and data extensions. It includes more queries than the built-in `security-experimental.qls` suite, providing a more thorough analysis at the cost of longer analysis times and potential false positives. It includes:
18+
This `synthetics.yml` configuration is intended for analyzing synthetic ([intentionally vulnerable](https://owasp.org/www-project-vulnerable-web-applications-directory/)) code samples. This configuration uses all possible security queries/extensions from the CodeQL built in packs, the CodeQL Community Packs, and additional OSS packs. It also includes the queries from the built-in `security-experimental.qls` suite with additional lower precision/experimental queries:
1819
- queries marked as `@precision: low` or missing a precision
1920
- queries marked as `@problem.severity: recommendation`
2021
- queries in `\experimental\` folders
22+
23+
This configuration will provide a more thorough analysis at the cost of longer analysis times and potential false positives. Consider using the `audit.yml` configuration to look for additional false negative scenarios.

0 commit comments

Comments
 (0)