CodeQL CLI SARIF output
You can output SARIF from the CodeQL CLI and share static analysis results with other systems.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
About SARIF output
SARIF is designed to represent the output of a broad range of static analysis tools, and there are many features in the SARIF specification that areconsidered "optional". This document details the output produced when using the format typesarifv2.1.0, which corresponds to the SARIF v2.1.0.csd1 specification. For more information on selecting a file format for your analysis results, seedatabase analyze.
SARIF specification and schema
This article is intended to be read alongside the detailed SARIF specification. For more information on the specification and the SARIF schema, see theSARIF specification documentation.
Change notes
Changes between versions
| CodeQL version | Format type | Changes |
|---|---|---|
| 2.0.0 | sarifv2.1.0 | First version of this format. |
Future changes to the output
The output produced for a given specific format type (for example,sarifv2.1.0) may change in future CodeQL releases. We will endeavor to maintain backwards compatibility with consumers of the generated SARIF by ensuring that:
Fields that are marked as always being generated will never be removed.
For fields that are marked as not always being generated, the circumstances under which the fields are generated may change. Consumers of the CodeQL SARIF output should be robust to the presence or absence of these fields.
New output fields may be added in future releases under the same format type–these are not considered to break backwards compatibility, and consumers should be robust to the presence of newly added fields.
New format argument types may be added in future versions of CodeQL—for example, to support new versions of SARIF. These have no guarantee of backwards compatibility, unless explicitly documented.
Generated SARIF objects
This details each SARIF component that may be generated, along with any specific circumstances. We omit any properties that are never generated.
sarifLog object
| JSON property name | Always generated? | Notes |
|---|---|---|
$schema | Provides a link to theSARIF schema. | |
version | The version of the SARIF used to generate the output. | |
runs | An array containing a single run object, for one language. |
run object
| JSON property name | Always generated? | Notes |
|---|---|---|
tool | None | |
artifacts | An array containing at least one artifact object for every file referenced in a result. | |
results | None | |
newLineSequences | None | |
columnKind | None | |
properties | The properties dictionary will contain thesemmle.formatSpecifier, which identifies the format specifier passed to the CodeQL CLI. |
tool object
| JSON property name | Always generated? | Notes |
|---|---|---|
driver | None |
toolComponent object
| JSON property name | Always generated? | Notes |
|---|---|---|
name | Set to "CodeQL command-line toolchain" for output from the CodeQL CLI tools. Note, if the output was generated using a different tool a differentname is reported, and the format may not be as described here. | |
organization | Set to "GitHub". | |
version | Set to the CodeQL release version e.g. "2.0.0". | |
rules | An array ofreportingDescriptor objects that represent rules. This array will contain, at a minimum, all the rules that were run during this analysis, but may contain rules which were available but not run. For more detail about enabling queries, seedefaultConfiguration. |
reportingDescriptor object (for rule)
reportingDescriptor objects may be used in multiple places in the SARIF specification. When areportingDescriptor is included in the rules array of atoolComponent object it has the following properties.
| JSON property name | Always generated? | Notes |
|---|---|---|
id | Will contain the@id property specified in the query that defines the rule, which is usually of the formatlanguage/rule-name (for examplecpp/unsafe-format-string). If your organization defines the@opaqueid property in the query it will be used instead. | |
name | Will contain the@id property specified in the query. See theid property above for an example. | |
shortDescription | Will contain the@name property specified in the query that defines the rule. | |
fullDescription | Will contain the@description property specified in the query that defines the rule. | |
defaultConfiguration | AreportingConfiguration object, with the enabled property set to true or false, and a level property set according to the@severity property specified in the query that defines the rule. Omitted if the@severity property was not specified. |
artifact object
| JSON property name | Always generated? | Notes |
|---|---|---|
location | AnartifactLocation object. | |
index | The index of theartifact object. | |
contents | If results are generated using the--sarif-add-file-contents flag, and the source code is available at the time the SARIF file is generated, then thecontents property is populated with anartifactContent object, with thetext property set. |
artifactLocation object
| JSON property name | Always generated? | Notes |
|---|---|---|
uri | None | |
index | None | |
uriBaseId | If the file is relative to some known abstract location, such as the root source location on the analysis machine, this will be set. |
result object
The composition of the results is dependent on the options provided to CodeQL. By default, the results are grouped by unique message format string and primary location. Thus, two results that occur at the same location with the same underlying message, will appear as a single result in the output. This behavior can be disabled by using the flag--ungroup-results, in which case no results are grouped.
| JSON property name | Always generated? | Notes |
|---|---|---|
ruleId | See the description of theid property inreportingDescriptor object (for rule) . | |
ruleIndex | None | |
message | A message describing the problem(s) occurring at this location. This message may be a SARIF "Message with placeholder", containing links that refer to locations in therelatedLocations property. | |
locations | An array containing a singlelocation object. | |
partialFingerprints | A dictionary from named fingerprint types to the fingerprint. This will contain, at a minimum, a value for theprimaryLocationLineHash, which provides a fingerprint based on the context of the primary location. | |
codeFlows | This array may be populated with one or morecodeFlow objects if the query that defines the rule for this result is of@kind path-problem. | |
relatedLocations | This array will be populated if the query that defines the rule for this result has a message with placeholder options. Each unique location is included once. | |
suppressions | If the result is suppressed, then this will contain a singlesuppression object, with the@kind property set toIN_SOURCE. If this result is not suppressed, but there is at least one result that has a suppression, then this will be set to an empty array, otherwise it will not be set. |
location object
| JSON property name | Always generated? | Notes |
|---|---|---|
physicalLocation | None | |
id | location objects that appear in therelatedLocations array of aresult object may contain theid property. | |
message | location objects may contain themessage property if:- They appear in the relatedLocations array of aresult object may contain themessage property.- They appear in the threadFlowLocation.location property. |
physicalLocation object
| JSON property name | Always generated? | Notes |
|---|---|---|
artifactLocation | None | |
region | If the givenphysicalLocation exists in a text file, such as a source code file, then theregion property may be present. | |
contextRegion | May be present if this location has an associatedsnippet. |
region object
There are two types ofregion object produced by CodeQL:
Line/column offset regions
Character offset and length regions
Any region produced by CodeQL may be specified in either format, and consumers should robustly handle either type.
For line/column offset regions, the following properties will be set:
| JSON property name | Always generated? | Notes |
|---|---|---|
startLine | None | |
startColumn | Not included if equal to the default value of 1. | |
endLine | Not included if identical tostartLine. | |
endColumn | None | |
snippet | None |
For character offset and length regions, the following properties will be set:
| JSON property name | Always generated? | Notes |
|---|---|---|
charOffset | Provided ifstartLine,startColumn,endLine, andendColumn are not populated. | |
charLength | Provided ifstartLine,startColumn,endLine, andendColumn are not populated. | |
snippet | None |
codeFlow object
| JSON property name | Always generated? | Notes |
|---|---|---|
threadFlows | None |
threadFlow object
| JSON property name | Always generated? | Notes |
|---|---|---|
locations | None |
threadFlowLocation object
| JSON property name | Always generated? | Notes |
|---|---|---|
location | None |