SARIF: Tweak format for GitHub UI (#571)

* sarif: Tweak format for GitHub UI Signed-off-by: Simarpreet Singh <[email protected]> * sarif: Make sarif easier to use with a default template This will help us use Trivy in places like GitHub Actions where we cannot specify a template as input. $ trivy image --format=sarif alpine:3.10.1 Signed-off-by: Simarpreet Singh <[email protected]> * Revert "sarif: Make sarif easier to use with a default template" This reverts commit 5b5d1c8. * .dockerignore: Add un-needed large directories Signed-off-by: Simarpreet Singh <[email protected]> * Dockerfile: Add sarif template. This will let users run and save the output through the docker image Example: ``` docker run --rm -it -v $(pwd):/tmp aquasec/trivy:latest image -f template --template "@contrib/sarif.tpl" --output="/tmp/sarif.test" alpine:3.10.2 ``` Signed-off-by: Simarpreet Singh <[email protected]>
aquasecurity · Jul 28, 2020 · 4d721e1 · 4d721e1
1 parent 9c91da8
commit 4d721e1
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 29 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,2 +1,6 @@
+.git
+.github
+.cache
 .circleci
+integration
 imgs
diff --git a/Dockerfile b/Dockerfile
@@ -4,5 +4,6 @@ RUN apk --no-cache add ca-certificates git rpm
 COPY trivy /usr/local/bin/trivy
 COPY contrib/gitlab.tpl contrib/gitlab.tpl
 COPY contrib/junit.tpl contrib/junit.tpl
+COPY contrib/sarif.tpl contrib/sarif.tpl
 USER appuser
 ENTRYPOINT ["trivy"]
diff --git a/contrib/sarif.tpl b/contrib/sarif.tpl
@@ -1,11 +1,12 @@
 {
-  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+  "$schema": "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.4.json",
   "version": "2.1.0",
   "runs": [
     {
       "tool": {
         "driver": {
-          "name": "Trivy: Vulnerability Scanner for Containers",
+          "name": "Trivy",
+          "fullName": "Trivy Vulnerability Scanner",
           "rules": [
         {{- $t_first := true }}
         {{- range . }}
@@ -17,16 +18,21 @@
               {{- end }}
             {
               "id": "[{{ .Vulnerability.Severity }}] {{ .VulnerabilityID }}",
-              "name": "container_scanning",
+              "name": "dockerfile_scan",
               "shortDescription": {
-                "text": {{ printf "error found in package %s." (print .PkgName .Title ) | printf "%q" }}
+                "text": "{{ .VulnerabilityID }} Package: {{ .PkgName }}"
               },
               "fullDescription": {
-                "text": {{ endWithPeriod .Description | printf "%q" }}
+                "text": "{{ endWithPeriod .Title }}"
+              },
+              "help": {
+                "text": "Vulnerability {{ .VulnerabilityID }}\nSeverity: {{ .Vulnerability.Severity }}\nPackage: {{ .PkgName }}\nInstalled Version: {{ .InstalledVersion }}\nFixed Version: {{ .FixedVersion }}\nLink: [{{ .VulnerabilityID }}](https://nvd.nist.gov/vuln/detail/{{ .VulnerabilityID | toLower }})",
+                "markdown": "**Vulnerability {{ .VulnerabilityID }}**\n| Severity | Package | Installed Version | Fixed Version | Link |\n| --- | --- | --- | --- | --- |\n|{{ .Vulnerability.Severity }}|{{ .PkgName }}|{{ .InstalledVersion }}|{{ .FixedVersion }}|[{{ .VulnerabilityID }}](https://nvd.nist.gov/vuln/detail/{{ .VulnerabilityID | toLower }})|\n"
               },
-              "defaultConfiguration": null,
               "properties": {
                 "tags": [
+                  "vulnerability",
+                  "{{ .Vulnerability.Severity }}",
                   "{{ .PkgName }}"
                 ],
                 "precision": "very-high"
@@ -53,7 +59,18 @@
           "message": {
             "text": {{ endWithPeriod $vulnerability.Description | printf "%q" }}
           },
-          "locations": []
+          "locations": [{
+            "physicalLocation": {
+              "artifactLocation": {
+                "uri": "Dockerfile"
+              },
+              "region": {
+                "startLine": 1,
+                "startColumn": 1,
+                "endColumn": 1
+              }
+            }
+          }]
         }
         {{- end -}}
       {{- end -}}

diff --git a/goreleaser.yml b/goreleaser.yml
@@ -95,3 +95,4 @@ dockers:
     extra_files:
     - contrib/gitlab.tpl
     - contrib/junit.tpl
+    - contrib/sarif.tpl
diff --git a/integration/testdata/alpine-310.sarif.golden b/integration/testdata/alpine-310.sarif.golden
@@ -1,75 +1,96 @@
 {
-  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+  "$schema": "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.4.json",
   "version": "2.1.0",
   "runs": [
     {
       "tool": {
         "driver": {
-          "name": "Trivy: Vulnerability Scanner for Containers",
+          "name": "Trivy",
+          "fullName": "Trivy Vulnerability Scanner",
           "rules": [
             {
               "id": "[MEDIUM] CVE-2019-1549",
-              "name": "container_scanning",
+              "name": "dockerfile_scan",
               "shortDescription": {
-                "text": "error found in package opensslopenssl: information disclosure in fork()."
+                "text": "CVE-2019-1549 Package: openssl"
               },
               "fullDescription": {
-                "text": "OpenSSL 1.1.1 introduced a rewritten random number generator (RNG). This was intended to include protection in the event of a fork() system call in order to ensure that the parent and child processes did not share the same RNG state. However this protection was not being used in the default case. A partial mitigation for this issue is that the output from a high precision timer is mixed into the RNG state so the likelihood of a parent and child process sharing state is significantly reduced. If an application already calls OPENSSL_init_crypto() explicitly using OPENSSL_INIT_ATFORK then this problem does not occur at all. Fixed in OpenSSL 1.1.1d (Affected 1.1.1-1.1.1c)."
+                "text": "openssl: information disclosure in fork()."
+              },
+              "help": {
+                "text": "Vulnerability CVE-2019-1549\nSeverity: MEDIUM\nPackage: openssl\nInstalled Version: 1.1.1c-r0\nFixed Version: 1.1.1d-r0\nLink: [CVE-2019-1549](https://nvd.nist.gov/vuln/detail/cve-2019-1549)",
+                "markdown": "**Vulnerability CVE-2019-1549**\n| Severity | Package | Installed Version | Fixed Version | Link |\n| --- | --- | --- | --- | --- |\n|MEDIUM|openssl|1.1.1c-r0|1.1.1d-r0|[CVE-2019-1549](https://nvd.nist.gov/vuln/detail/cve-2019-1549)|\n"
               },
-              "defaultConfiguration": null,
               "properties": {
                 "tags": [
+                  "vulnerability",
+                  "MEDIUM",
                   "openssl"
                 ],
                 "precision": "very-high"
               }
             },
             {
               "id": "[MEDIUM] CVE-2019-1551",
-              "name": "container_scanning",
+              "name": "dockerfile_scan",
               "shortDescription": {
-                "text": "error found in package opensslopenssl: Integer overflow in RSAZ modular exponentiation on x86_64."
+                "text": "CVE-2019-1551 Package: openssl"
               },
               "fullDescription": {
-                "text": "There is an overflow bug in the x64_64 Montgomery squaring procedure used in exponentiation with 512-bit moduli. No EC algorithms are affected. Analysis suggests that attacks against 2-prime RSA1024, 3-prime RSA1536, and DSA1024 as a result of this defect would be very difficult to perform and are not believed likely. Attacks against DH512 are considered just feasible. However, for an attack the target would have to re-use the DH512 private key, which is not recommended anyway. Also applications directly using the low level API BN_mod_exp may be affected if they use BN_FLG_CONSTTIME. Fixed in OpenSSL 1.1.1e (Affected 1.1.1-1.1.1d). Fixed in OpenSSL 1.0.2u (Affected 1.0.2-1.0.2t)."
+                "text": "openssl: Integer overflow in RSAZ modular exponentiation on x86_64."
+              },
+              "help": {
+                "text": "Vulnerability CVE-2019-1551\nSeverity: MEDIUM\nPackage: openssl\nInstalled Version: 1.1.1c-r0\nFixed Version: 1.1.1d-r2\nLink: [CVE-2019-1551](https://nvd.nist.gov/vuln/detail/cve-2019-1551)",
+                "markdown": "**Vulnerability CVE-2019-1551**\n| Severity | Package | Installed Version | Fixed Version | Link |\n| --- | --- | --- | --- | --- |\n|MEDIUM|openssl|1.1.1c-r0|1.1.1d-r2|[CVE-2019-1551](https://nvd.nist.gov/vuln/detail/cve-2019-1551)|\n"
               },
-              "defaultConfiguration": null,
               "properties": {
                 "tags": [
+                  "vulnerability",
+                  "MEDIUM",
                   "openssl"
                 ],
                 "precision": "very-high"
               }
             },
             {
               "id": "[MEDIUM] CVE-2019-1563",
-              "name": "container_scanning",
+              "name": "dockerfile_scan",
               "shortDescription": {
-                "text": "error found in package opensslopenssl: information disclosure in PKCS7_dataDecode and CMS_decrypt_set1_pkey."
+                "text": "CVE-2019-1563 Package: openssl"
               },
               "fullDescription": {
-                "text": "In situations where an attacker receives automated notification of the success or failure of a decryption attempt an attacker, after sending a very large number of messages to be decrypted, can recover a CMS/PKCS7 transported encryption key or decrypt any RSA encrypted message that was encrypted with the public RSA key, using a Bleichenbacher padding oracle attack. Applications are not affected if they use a certificate together with the private RSA key to the CMS_decrypt or PKCS7_decrypt functions to select the correct recipient info to decrypt. Fixed in OpenSSL 1.1.1d (Affected 1.1.1-1.1.1c). Fixed in OpenSSL 1.1.0l (Affected 1.1.0-1.1.0k). Fixed in OpenSSL 1.0.2t (Affected 1.0.2-1.0.2s)."
+                "text": "openssl: information disclosure in PKCS7_dataDecode and CMS_decrypt_set1_pkey."
+              },
+              "help": {
+                "text": "Vulnerability CVE-2019-1563\nSeverity: MEDIUM\nPackage: openssl\nInstalled Version: 1.1.1c-r0\nFixed Version: 1.1.1d-r0\nLink: [CVE-2019-1563](https://nvd.nist.gov/vuln/detail/cve-2019-1563)",
+                "markdown": "**Vulnerability CVE-2019-1563**\n| Severity | Package | Installed Version | Fixed Version | Link |\n| --- | --- | --- | --- | --- |\n|MEDIUM|openssl|1.1.1c-r0|1.1.1d-r0|[CVE-2019-1563](https://nvd.nist.gov/vuln/detail/cve-2019-1563)|\n"
               },
-              "defaultConfiguration": null,
               "properties": {
                 "tags": [
+                  "vulnerability",
+                  "MEDIUM",
                   "openssl"
                 ],
                 "precision": "very-high"
               }
             },
             {
               "id": "[LOW] CVE-2019-1547",
-              "name": "container_scanning",
+              "name": "dockerfile_scan",
               "shortDescription": {
-                "text": "error found in package opensslopenssl: side-channel weak encryption vulnerability."
+                "text": "CVE-2019-1547 Package: openssl"
               },
               "fullDescription": {
-                "text": "Normally in OpenSSL EC groups always have a co-factor present and this is used in side channel resistant code paths. However, in some cases, it is possible to construct a group using explicit parameters (instead of using a named curve). In those cases it is possible that such a group does not have the cofactor present. This can occur even where all the parameters match a known named curve. If such a curve is used then OpenSSL falls back to non-side channel resistant code paths which may result in full key recovery during an ECDSA signature operation. In order to be vulnerable an attacker would have to have the ability to time the creation of a large number of signatures where explicit parameters with no co-factor present are in use by an application using libcrypto. For the avoidance of doubt libssl is not vulnerable because explicit parameters are never used. Fixed in OpenSSL 1.1.1d (Affected 1.1.1-1.1.1c). Fixed in OpenSSL 1.1.0l (Affected 1.1.0-1.1.0k). Fixed in OpenSSL 1.0.2t (Affected 1.0.2-1.0.2s)."
+                "text": "openssl: side-channel weak encryption vulnerability."
+              },
+              "help": {
+                "text": "Vulnerability CVE-2019-1547\nSeverity: LOW\nPackage: openssl\nInstalled Version: 1.1.1c-r0\nFixed Version: 1.1.1d-r0\nLink: [CVE-2019-1547](https://nvd.nist.gov/vuln/detail/cve-2019-1547)",
+                "markdown": "**Vulnerability CVE-2019-1547**\n| Severity | Package | Installed Version | Fixed Version | Link |\n| --- | --- | --- | --- | --- |\n|LOW|openssl|1.1.1c-r0|1.1.1d-r0|[CVE-2019-1547](https://nvd.nist.gov/vuln/detail/cve-2019-1547)|\n"
               },
-              "defaultConfiguration": null,
               "properties": {
                 "tags": [
+                  "vulnerability",
+                  "LOW",
                   "openssl"
                 ],
                 "precision": "very-high"
@@ -85,7 +106,18 @@
           "message": {
             "text": "OpenSSL 1.1.1 introduced a rewritten random number generator (RNG). This was intended to include protection in the event of a fork() system call in order to ensure that the parent and child processes did not share the same RNG state. However this protection was not being used in the default case. A partial mitigation for this issue is that the output from a high precision timer is mixed into the RNG state so the likelihood of a parent and child process sharing state is significantly reduced. If an application already calls OPENSSL_init_crypto() explicitly using OPENSSL_INIT_ATFORK then this problem does not occur at all. Fixed in OpenSSL 1.1.1d (Affected 1.1.1-1.1.1c)."
           },
-          "locations": []
+          "locations": [{
+            "physicalLocation": {
+              "artifactLocation": {
+                "uri": "Dockerfile"
+              },
+              "region": {
+                "startLine": 1,
+                "startColumn": 1,
+                "endColumn": 1
+              }
+            }
+          }]
         },
         {
           "ruleId": "[MEDIUM] CVE-2019-1551",
@@ -94,7 +126,18 @@
           "message": {
             "text": "There is an overflow bug in the x64_64 Montgomery squaring procedure used in exponentiation with 512-bit moduli. No EC algorithms are affected. Analysis suggests that attacks against 2-prime RSA1024, 3-prime RSA1536, and DSA1024 as a result of this defect would be very difficult to perform and are not believed likely. Attacks against DH512 are considered just feasible. However, for an attack the target would have to re-use the DH512 private key, which is not recommended anyway. Also applications directly using the low level API BN_mod_exp may be affected if they use BN_FLG_CONSTTIME. Fixed in OpenSSL 1.1.1e (Affected 1.1.1-1.1.1d). Fixed in OpenSSL 1.0.2u (Affected 1.0.2-1.0.2t)."
           },
-          "locations": []
+          "locations": [{
+            "physicalLocation": {
+              "artifactLocation": {
+                "uri": "Dockerfile"
+              },
+              "region": {
+                "startLine": 1,
+                "startColumn": 1,
+                "endColumn": 1
+              }
+            }
+          }]
         },
         {
           "ruleId": "[MEDIUM] CVE-2019-1563",
@@ -103,7 +146,18 @@
           "message": {
             "text": "In situations where an attacker receives automated notification of the success or failure of a decryption attempt an attacker, after sending a very large number of messages to be decrypted, can recover a CMS/PKCS7 transported encryption key or decrypt any RSA encrypted message that was encrypted with the public RSA key, using a Bleichenbacher padding oracle attack. Applications are not affected if they use a certificate together with the private RSA key to the CMS_decrypt or PKCS7_decrypt functions to select the correct recipient info to decrypt. Fixed in OpenSSL 1.1.1d (Affected 1.1.1-1.1.1c). Fixed in OpenSSL 1.1.0l (Affected 1.1.0-1.1.0k). Fixed in OpenSSL 1.0.2t (Affected 1.0.2-1.0.2s)."
           },
-          "locations": []
+          "locations": [{
+            "physicalLocation": {
+              "artifactLocation": {
+                "uri": "Dockerfile"
+              },
+              "region": {
+                "startLine": 1,
+                "startColumn": 1,
+                "endColumn": 1
+              }
+            }
+          }]
         },
         {
           "ruleId": "[LOW] CVE-2019-1547",
@@ -112,7 +166,18 @@
           "message": {
             "text": "Normally in OpenSSL EC groups always have a co-factor present and this is used in side channel resistant code paths. However, in some cases, it is possible to construct a group using explicit parameters (instead of using a named curve). In those cases it is possible that such a group does not have the cofactor present. This can occur even where all the parameters match a known named curve. If such a curve is used then OpenSSL falls back to non-side channel resistant code paths which may result in full key recovery during an ECDSA signature operation. In order to be vulnerable an attacker would have to have the ability to time the creation of a large number of signatures where explicit parameters with no co-factor present are in use by an application using libcrypto. For the avoidance of doubt libssl is not vulnerable because explicit parameters are never used. Fixed in OpenSSL 1.1.1d (Affected 1.1.1-1.1.1c). Fixed in OpenSSL 1.1.0l (Affected 1.1.0-1.1.0k). Fixed in OpenSSL 1.0.2t (Affected 1.0.2-1.0.2s)."
           },
-          "locations": []
+          "locations": [{
+            "physicalLocation": {
+              "artifactLocation": {
+                "uri": "Dockerfile"
+              },
+              "region": {
+                "startLine": 1,
+                "startColumn": 1,
+                "endColumn": 1
+              }
+            }
+          }]
         }],
       "columnKind": "utf16CodeUnits"
     }

diff --git a/pkg/report/writer.go b/pkg/report/writer.go
@@ -57,6 +57,9 @@ func WriteResults(format string, output io.Writer, results Results, outputTempla
 				}
 				return input
 			},
+			"toLower": func(input string) string {
+				return strings.ToLower(input)
+			},
 		}).Parse(outputTemplate)
 		if err != nil {
 			return xerrors.Errorf("error parsing template: %w", err)