feat: add fingerprint to report and move skip rule to docs (#1023)

* feat: add fingerprint to report * feat: add skip-rule config to docs * chore: update stale snapshots
Bearer · May 31, 2023 · 37f23e3 · 37f23e3
1 parent 077a311
commit 37f23e3
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/docs/reference/rule-pages.njk b/docs/reference/rule-pages.njk
@@ -59,5 +59,18 @@ rule.metadata %}
         {% endfor %}
       </ul>
     {% endif %}
+  {% endif %}
+
+{% renderTemplate "liquid,md", rule.metadata %}
+  ## Configuration
+
+  To skip this rule during a scan, use the following flag
+  ```shell
+  bearer scan /path/to/your-project/ --skip-rule={{id}}
+  ```
 
-  {% endif %}
+  To run _only_ this rule during a scan, use the following flag
+  ```shell
+  bearer scan /path/to/your-project/ --only-rule={{id}}
+  ```
+{% endrenderTemplate %}
diff --git a/pkg/report/output/security/.snapshots/TestBuildReportString b/pkg/report/output/security/.snapshots/TestBuildReportString
@@ -10,15 +10,15 @@ Rules:
 
 CRITICAL: Sensitive data sent to Rails loggers detected. [CWE-209, CWE-532]
 https://docs.bearer.com/reference/rules/ruby_rails_logger
-To skip this rule, use the flag --skip-rule=ruby_rails_logger
+To exclude this finding, use the flag --exclude-fingerprint=375d7c2e9977cf2ce5dbf04b04237bea_0
 
 File: :1
 
 
 
 HIGH: Missing SSL certificate verification detected. [CWE-295]
 https://docs.bearer.com/reference/rules/ruby_lang_ssl_verification
-To skip this rule, use the flag --skip-rule=ruby_lang_ssl_verification
+To exclude this finding, use the flag --exclude-fingerprint=9005ef3db844b32c1a0317e032f4a16a_0
 
 File: :2
 

diff --git a/pkg/report/output/security/security.go b/pkg/report/output/security/security.go
@@ -523,7 +523,7 @@ func writeFailureToString(reportStr *strings.Builder, result Result, severity st
 		reportStr.WriteString(color.HiBlackString(result.DocumentationUrl + "\n"))
 	}
 
-	reportStr.WriteString(color.HiBlackString("To skip this rule, use the flag --skip-rule=" + result.Id + "\n"))
+	reportStr.WriteString(color.HiBlackString("To exclude this finding, use the flag --exclude-fingerprint=" + result.Fingerprint + "\n"))
 	reportStr.WriteString("\n")
 	if result.DetailedContext != "" {
 		reportStr.WriteString("Detected: " + result.DetailedContext + "\n\n")