Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .codeqlmanifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
"provide": [
"codeql/*/ql/src/qlpack.yml",
"codeql/*/ql/lib/qlpack.yml",
"codeql-go/*/ql/src/qlpack.yml",
"codeql-go/*/ql/lib/qlpack.yml",
"*/qlpack.yml",
"*/customizations/qlpack.yml",
"go/qlpack.yml",
Expand Down
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,41 @@ GitHub's Field Team's CodeQL Custom Queries, Suites, and Configurations

## Getting Started

Add the GitHub Field Team's config-file as part of Actions.
### Field Queries

To enabled and use the GitHub Field Team queries, you can easily add the following configuration file as part of Actions:

```yaml
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
uses: github/codeql-action/init@v2
with:
config-file: advanced-security/codeql-queries/config/codeql.yml@main
```

### Local Development
If you want to use any of the queries but you are using your own configuration file, please just add use statements like the following:

```yaml
name: "My Custom Configuration File"

queries:
# Simple Query
- uses: advanced-security/codeql-queries/{LANGUAGE}/CWE-{CWEID}/{QUERY_NAME}.ql@main
# Standard Query Suite
- uses: advanced-security/codeql-queries/{LANGUAGE}/suites/codeql-{LANGUAGE}.qls@main
# Audit queries
- uses: advanced-security/codeql-queries/{LANGUAGE}/suites/codeql-{LANGUAGE}-audit.qls@main
```

*Note: Referencing the queries directly like this will cause an query compile step and will slow down your analysis*

```bash
git clone --recursive https://github.com/advanced-security/codeql-queries.git && code .
### Field Audit / Debugging Queries

To enable and use the audit queries from the GitHub Field Security team, you can add the following configuration file to your Action:

```yaml
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
config-file: advanced-security/codeql-queries/config/codeql-audit.yml@main
```

38 changes: 36 additions & 2 deletions codeql-queries.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"path": "go"
},
{
"name": "Queries - Java",
"name": "Queries - Java/Kotlin",
"path": "java"
},
{
Expand All @@ -28,10 +28,18 @@
"name": "Queries - Ruby",
"path": "ruby"
},
{
"name": "Queries - Swift",
"path": "swift"
},
{
"name": "Tests",
"path": "tests"
},
{
"name": "Config",
"path": "config"
},
{
"name": "CodeQL - Query Languages",
"path": "codeql"
Expand All @@ -45,5 +53,31 @@
"codeQL.runningQueries.debug": true,
"editor.formatOnSave": true,
"editor.formatOnPaste": true
}
},
"tasks": {
"version": "2.0.0",
"tasks": [
{
"label": "Generate Coverage Reports",
"type": "shell",
"command": "python3 ./.github/scripts/generate-coverage.py -l ${input:language} --disable-cache",
"problemMatcher": [],
"options": {
"cwd": ".."
},
"group": {
"kind": "build",
"isDefault": true
}
}
],
"inputs": [
{
"id": "language",
"description": "Language",
"default": "all",
"type": "promptString"
}
]
},
}
4 changes: 4 additions & 0 deletions csharp/.data/queries.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"codeql/csharp/ql/src/Diagnostics/ExtractorMessage.ql",
"codeql/csharp/ql/src/Metrics/Summaries/LinesOfCode.ql",
"codeql/csharp/ql/src/Telemetry/ExternalLibraryUsage.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalApis.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSinks.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSources.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalTaint.ql",
Expand Down Expand Up @@ -121,6 +122,7 @@
"codeql/csharp/ql/src/Diagnostics/ExtractorMessage.ql",
"codeql/csharp/ql/src/Metrics/Summaries/LinesOfCode.ql",
"codeql/csharp/ql/src/Telemetry/ExternalLibraryUsage.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalApis.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSinks.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSources.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalTaint.ql",
Expand Down Expand Up @@ -294,6 +296,7 @@
"codeql/csharp/ql/src/Diagnostics/ExtractorMessage.ql",
"codeql/csharp/ql/src/Metrics/Summaries/LinesOfCode.ql",
"codeql/csharp/ql/src/Telemetry/ExternalLibraryUsage.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalApis.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSinks.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSources.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalTaint.ql",
Expand Down Expand Up @@ -366,6 +369,7 @@
"codeql/csharp/ql/src/Diagnostics/ExtractorMessage.ql",
"codeql/csharp/ql/src/Metrics/Summaries/LinesOfCode.ql",
"codeql/csharp/ql/src/Telemetry/ExternalLibraryUsage.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalApis.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSinks.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalSources.ql",
"codeql/csharp/ql/src/Telemetry/SupportedExternalTaint.ql",
Expand Down
8 changes: 4 additions & 4 deletions csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<!-- AUTOMATION-SUITES -->
| Name | Queries Count | Description | Path |
| :--- | :---- | :--- | :--- |
| `default` | 53 | Default Query Suite | `codeql/csharp/ql/src/codeql-suites/code-scanning` |
| `extended` | 70 | Security Extended Suite | `codeql/csharp/ql/src/codeql-suites/security-extended` |
| `quality` | 171 | Security and Quality Extended Suite | `codeql/csharp/ql/src/codeql-suites/security-and-quality` |
| `super-extended` | 80 | Security Extended with Experimental and Custom Queries Suite | `advanced-security/codeql-queries/csharp/suites/codeql-csharp.qls@main` |
| `default` | 54 | Default Query Suite | `codeql/csharp/ql/src/codeql-suites/code-scanning` |
| `extended` | 71 | Security Extended Suite | `codeql/csharp/ql/src/codeql-suites/security-extended` |
| `quality` | 172 | Security and Quality Extended Suite | `codeql/csharp/ql/src/codeql-suites/security-and-quality` |
| `super-extended` | 81 | Security Extended with Experimental and Custom Queries Suite | `advanced-security/codeql-queries/csharp/suites/codeql-csharp.qls@main` |


<!-- AUTOMATION-SUITES -->
Loading