Skip to content

Commit 41e1279

Browse files
committed
Config updates
- add queries that explicitly target local sources from OSS pack (pulls in built in queries) - publish a config that explicitly targets local sources where possible (without pulling in lower precision queries) - audit pack is working better now due to fix GitHubSecurityLab/CodeQL-Community-Packs#35
1 parent 71b1751 commit 41e1279

File tree

3 files changed

+110
-65
lines changed

3 files changed

+110
-65
lines changed

config/codeql-audit.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# TODO: WORK IN PROGRESS: https://github.com/GitHubSecurityLab/CodeQL-Community-Packs/pull/35
21
# Use this configuration file when looking to audit the codebase for security risks.
32
# WARNING: A notable amount of false positives may be found in this configuration. If you wish to reduce the number of false positives, use the default codeql suites :)
43

@@ -11,7 +10,7 @@ threat-models: local
1110
disable-default-queries: true
1211

1312
packs:
14-
# OSS audit queries from the default suites for the GitHub Security Lab's Community Packs https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
13+
# OSS audit queries from the default suites for the GitHub Security Lab's Community Packs https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
1514
- githubsecuritylab/codeql-cpp-queries:suites/cpp-audit.qls
1615
- githubsecuritylab/codeql-csharp-queries:suites/csharp-audit.qls
1716
- githubsecuritylab/codeql-go-queries:suites/go-audit.qls
@@ -26,4 +25,4 @@ packs:
2625

2726
# Data extensions from the GitHub Security Lab https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
2827
- githubsecuritylab/codeql-csharp-extensions
29-
- githubsecuritylab/codeql-java-extensions
28+
- githubsecuritylab/codeql-java-extensions

config/codeql-local.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Use this configuration file when looking to expand the sources of vulnerability data using CodeQL Built in queries,custom queries, and data extensions.
2+
# A notable amount of false positives may be found in this configuration. If you wish to reduce the number of false positives, use the default codeql suites :)
3+
name: "Synthetic Apps All Queries Config"
4+
5+
# expand thread model - https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#extending-codeql-coverage-with-threat-models
6+
threat-models: local
7+
8+
packs:
9+
### CodeQL Security Extended ###
10+
- codeql/cpp-queries:codeql-suites/cpp-security-extended.qls
11+
- codeql/csharp-queries:codeql-suites/csharp-security-extended.qls
12+
- codeql/go-queries:codeql-suites/go-security-extended.qls
13+
- codeql/java-queries:codeql-suites/java-security-extended.qls
14+
- codeql/javascript-queries:codeql-suites/javascript-security-extended.qls
15+
- codeql/python-queries:codeql-suites/python-security-extended.qls
16+
- codeql/ruby-queries:codeql-suites/ruby-security-extended.qls
17+
18+
# Queries via Community Packs that use local sources https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
19+
- githubsecuritylab/codeql-java-queries:suites/java-local.qls
20+
- githubsecuritylab/codeql-python-queries:suites/python-local.qls
21+
22+
# Data extensions via Community Packs for libraries (library ext models are those generated by the corresponding queries in src) https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
23+
- githubsecuritylab/codeql-csharp-library-sources
24+
- githubsecuritylab/codeql-java-library-sources
25+
26+
# Data extensions via Community Packs https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
27+
- githubsecuritylab/codeql-csharp-extensions
28+
- githubsecuritylab/codeql-java-extensions
29+
30+
#Additional extractor excludes: https://github.com/github/codeql/blob/768e5190a1c9d40a4acc7143c461c3b114e7fd59/javascript/extractor/src/com/semmle/js/extractor/AutoBuild.java#L421-L427C42
31+
paths-ignore:
32+
# Python
33+
- "vendor/**"
34+
- "examples/**"
35+
- "tests/**"
36+
37+
# JavaScript
38+
- "node_modules"
39+
- "**/*.test.js"
40+
- "**/*.test.tsx"
41+
- "**/*.spec.ts"
42+
- "**/*.spec.tsx"
43+
- "dist"

config/codeql-synthetics.yml

Lines changed: 65 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,38 @@ threat-models: local
1010
# start from scratch - https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#disabling-the-default-queries
1111
disable-default-queries: true
1212

13-
packs:
14-
# All queries from the CodeQL Built in packs
15-
- codeql/cpp-queries:.
16-
- codeql/csharp-queries:.
17-
- codeql/go-queries:.
13+
packs:
14+
# All queries from the CodeQL Built in packs (including low/no precision queries)
15+
- codeql/cpp-queries:.
16+
- codeql/csharp-queries:.
17+
- codeql/go-queries:.
1818
- codeql/java-queries:.
1919
- codeql/javascript-queries:.
2020
- codeql/python-queries:.
2121
- codeql/ruby-queries:.
2222
- codeql/swift-queries:.
2323

2424
# OSS queries from the default suites
25-
25+
2626
### GitHub Security Lab###
2727
# Queries via Community Packs https://github.com/GitHubSecurityLab/CodeQL-Community-Packs (NOTE: the default suites do not include audit/debugging queries)
2828
- githubsecuritylab/codeql-cpp-queries
2929
- githubsecuritylab/codeql-csharp-queries
3030
- githubsecuritylab/codeql-go-queries
3131
- githubsecuritylab/codeql-java-queries
32-
- githubsecuritylab/codeql-javascript-queries
32+
- githubsecuritylab/codeql-javascript-queries
3333
- githubsecuritylab/codeql-python-queries
34-
- githubsecuritylab/codeql-ruby-queries
34+
- githubsecuritylab/codeql-ruby-queries
35+
36+
# Queries via Community Packs that use local sources https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
37+
- githubsecuritylab/codeql-java-queries:suites/java-local.qls
38+
- githubsecuritylab/codeql-python-queries:suites/python-local.qls
3539

36-
# Data extensions for libraries (library ext models are those generated by the corresponding queries in src) from the GitHub Security Lab https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
40+
# Data extensions via Community Packs for libraries (library ext models are those generated by the corresponding queries in src) https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
3741
- githubsecuritylab/codeql-csharp-library-sources
3842
- githubsecuritylab/codeql-java-library-sources
3943

40-
# Data extensions from the GitHub Security Lab https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
44+
# Data extensions via Community Packs https://github.com/GitHubSecurityLab/CodeQL-Community-Packs
4145
- githubsecuritylab/codeql-csharp-extensions
4246
- githubsecuritylab/codeql-java-extensions
4347

@@ -52,60 +56,59 @@ packs:
5256
# - restriction of no experimental folder
5357
# - restriction of audit/debugging queries from community packs
5458
query-filters:
55-
- include:
56-
kind:
57-
- problem
58-
- path-problem
59-
tags contain:
60-
- security
61-
- include:
62-
kind:
63-
- diagnostic
64-
- include:
65-
kind:
66-
- metric
67-
tags contain:
68-
- summary
69-
- exclude:
70-
deprecated: //
71-
- exclude:
72-
query path:
73-
# REMOVE exclude - OK even if they exist in experimental folder
74-
#- /^experimental\/.*/
75-
- Metrics/Summaries/FrameworkCoverage.ql
76-
- /Diagnostics/Internal/.*/
77-
- exclude:
78-
tags contain:
79-
- modeleditor
80-
- modelgenerator
81-
# Exclude audit queries from the CodeQL Built in packs
82-
- exclude:
83-
id:
84-
- cpp/untrusted-data-to-external-api
85-
- cs/untrusted-data-to-external-api
86-
- go/untrusted-data-to-external-api
87-
- java/untrusted-data-to-external-api
88-
- js/untrusted-data-to-external-api
89-
- py/untrusted-data-to-external-api
90-
59+
- include:
60+
kind:
61+
- problem
62+
- path-problem
63+
tags contain:
64+
- security
65+
- include:
66+
kind:
67+
- diagnostic
68+
- include:
69+
kind:
70+
- metric
71+
tags contain:
72+
- summary
73+
- exclude:
74+
deprecated: //
75+
- exclude:
76+
query path:
77+
# REMOVE exclude - OK even if they exist in experimental folder
78+
#- /^experimental\/.*/
79+
- Metrics/Summaries/FrameworkCoverage.ql
80+
- /Diagnostics/Internal/.*/
81+
- exclude:
82+
tags contain:
83+
- modeleditor
84+
- modelgenerator
85+
# Exclude audit queries from the CodeQL Built in packs
86+
- exclude:
87+
id:
88+
- cpp/untrusted-data-to-external-api
89+
- cs/untrusted-data-to-external-api
90+
- go/untrusted-data-to-external-api
91+
- java/untrusted-data-to-external-api
92+
- js/untrusted-data-to-external-api
93+
- py/untrusted-data-to-external-api
9194

92-
# Remove debugging, and audit queries used by community packs (this is duplicative of the default suites from those community packs)
93-
- exclude:
94-
tags contain:
95-
- debugging
96-
- audit
95+
# Remove debugging, and audit queries used by community packs (this is duplicative of the default suites from those community packs)
96+
- exclude:
97+
tags contain:
98+
- debugging
99+
- audit
97100

98101
#Additional extractor excludes: https://github.com/github/codeql/blob/768e5190a1c9d40a4acc7143c461c3b114e7fd59/javascript/extractor/src/com/semmle/js/extractor/AutoBuild.java#L421-L427C42
99102
paths-ignore:
100-
# Python
101-
- "vendor/**"
102-
- "examples/**"
103-
- "tests/**"
103+
# Python
104+
- "vendor/**"
105+
- "examples/**"
106+
- "tests/**"
104107

105-
# JavaScript
106-
- "node_modules"
107-
- "**/*.test.js"
108-
- "**/*.test.tsx"
109-
- "**/*.spec.ts"
110-
- "**/*.spec.tsx"
111-
- "dist"
108+
# JavaScript
109+
- "node_modules"
110+
- "**/*.test.js"
111+
- "**/*.test.tsx"
112+
- "**/*.spec.ts"
113+
- "**/*.spec.tsx"
114+
- "dist"

0 commit comments

Comments
 (0)