Skip to content

Commit 2c6977e

Browse files
ethanpalmethanpalm
authored
Merge pull request github#6327 from ethanpalm/cwe-coverage-tables
CodeQL: Display CWE coverage information by language
2 parents fad1622 + 6a69932 commit 2c6977e

File tree

9 files changed

+78
-11
lines changed

9 files changed

+78
-11
lines changed

‎docs/codeql/query-help/codeql-cwe-coverage.md renamed to ‎docs/codeql/query-help/codeql-cwe-coverage.rst

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# CodeQL CWE coverage
1+
CodeQL CWE coverage
2+
===================
23

3-
An overview of the coverage of MITRE's Common Weakness Enumeration (CWE) for the latest release of CodeQL.
4+
You can view the full coverage of MITRE's Common Weakness Enumeration (CWE) or coverage by language for the latest release of CodeQL.
45

5-
## About CWEs
6+
About CWEs
7+
##########
68

79
The CWE categorization contains several types of entity, collectively known as CWEs. The CWEs that we consider in this report are only those of the types:
810

@@ -11,15 +13,22 @@ The CWE categorization contains several types of entity, collectively known as C
1113
- Weakness Variant
1214
- Compound Element
1315

14-
Other types of CWE do not correspond directly to weaknesses, so are omitted.
16+
Other types of CWE that do not correspond directly to weaknesses are omitted.
1517

1618
The CWE categorization includes relationships between entities, in particular a parent-child relationship.
17-
These relationships are associated with Views (another kind of CWE entity). For the purposes of coverage claims, we use the "[Research View](https://cwe.mitre.org/data/definitions/1000.html)."
19+
These relationships are associated with Views (another kind of CWE entity). For the purposes of coverage claims, we use the "`Research View <https://cwe.mitre.org/data/definitions/1000.html>`_."
1820

1921
Every security query is associated with one or more CWEs, which are the most precise CWEs that are covered by that query.
2022
Overall coverage is claimed for the most-precise CWEs, as well as for any of their ancestors in the View.
2123

22-
## Overview
23-
24-
<!-- autogenerated CWE coverage table will be added below -->
25-
24+
.. toctree::
25+
:hidden:
26+
:titlesonly:
27+
28+
full-cwe
29+
cpp-cwe
30+
csharp-cwe
31+
go-cwe
32+
java-cwe
33+
javascript-cwe
34+
python-cwe

‎docs/codeql/query-help/cpp-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CWE coverage for C and C++
2+
3+
An overview of CWE coverage for C and C++ in the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/csharp-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CWE coverage for C#
2+
3+
An overview of CWE coverage for C# in the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/full-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CodeQL full CWE coverage
2+
3+
An overview of the full coverage of MITRE's Common Weakness Enumeration (CWE) for the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/go-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CWE coverage for Go
2+
3+
An overview of CWE coverage for Go in the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/java-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CWE coverage for Java
2+
3+
An overview of CWE coverage for Java in the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/javascript-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CWE coverage for JavaScript
2+
3+
An overview of CWE coverage for JavaScript in the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/python-cwe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CWE coverage for Python
2+
3+
An overview of CWE coverage for Python in the latest release of CodeQL.
4+
5+
## Overview
6+
7+
<!-- autogenerated CWE coverage table will be added below -->
8+

‎docs/codeql/query-help/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ CodeQL query help Sphinx documentation
22
--------------------------------------
33

44
This project supplies the configuration and some boiler plate
5-
index files for the CodeQL query help documentation.
5+
index files for the CodeQL query help and CWE coverage documentation.
66

77
The query help itself is automatically generated by the
8-
"Generate CodeQL query help documentation using Sphinx" workflow.
8+
"Generate CodeQL query help documentation using Sphinx" workflow.
9+
10+
The CWE coverage tables are generated and appended to pages by the "Docs generate query help" workflow in the `semmle-code` repository.

0 commit comments

Comments
 (0)