doc(rules): improve doc

Bearer · Feb 8, 2023 · 293709a · 293709a
1 parent d0d5769
commit 293709a
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 10 deletions.
diff --git a/pkg/commands/process/settings/rules/ruby/rails/logger.yml b/pkg/commands/process/settings/rules/ruby/rails/logger.yml
@@ -23,7 +23,7 @@ severity:
 skip_data_types:
   - "Unique Identifier"
 metadata:
-  description: "Do not send sensitive data to loggers."
+  description: "Do not send sensitive data to Rails loggers."
   remediation_message: |
     ## Description
     Leaking sensitive data to loggers is a common cause of data leaks and can lead to data breaches. This rule looks for instances of sensitive data sent to rails loggers.

diff --git a/...s/logger/.snapshots/TestRubyRailsLoggerSummary-summary_ruby_rails_logger_datatype_leak.rb b/...s/logger/.snapshots/TestRubyRailsLoggerSummary-summary_ruby_rails_logger_datatype_leak.rb
@@ -2,7 +2,7 @@
     - policy_name: ""
       policy_dsrid: DSR-5
       policy_display_id: ruby_rails_logger
-      policy_description: Do not send sensitive data to loggers.
+      policy_description: Do not send sensitive data to Rails loggers.
       line_number: 1
       filename: pkg/commands/process/settings/rules/ruby/rails/logger/testdata/datatype_leak.rb
       category_groups:

diff --git a/pkg/commands/process/settings/rules/ruby/third_parties/bugsnag.yml b/pkg/commands/process/settings/rules/ruby/third_parties/bugsnag.yml
@@ -45,8 +45,7 @@ metadata:
     When logging errors or events, ensure all sensitive data is removed.
 
     ## Resources
-    - [Bugsnag Docs](https://)
-    - [Log obfuscation](https://)
+    - [Bugsnag Docs](https://docs.bugsnag.com/platforms/ruby/rails/)
   dsr_id: DSR-1
   associated_recipe: Bugsnag
   id: ruby_third_parties_bugsnag
diff --git a/pkg/commands/process/settings/rules/ruby/third_parties/honeybadger.yml b/pkg/commands/process/settings/rules/ruby/third_parties/honeybadger.yml
@@ -42,8 +42,7 @@ metadata:
     When logging errors or events, ensure all sensitive data is removed.
 
     ## Resources
-    - [Honeybadger Docs](https://)
-    - [Log obfuscation](https://)
+    - [Honeybadger Docs](https://docs.honeybadger.io/lib/ruby/integration-guides/rails-exception-tracking/)
   dsr_id: DSR-1
   associated_recipe: Honeybadger
   id: ruby_third_parties_honeybadger
diff --git a/pkg/report/output/summary/.snapshots/TestSummary b/pkg/report/output/summary/.snapshots/TestSummary
@@ -4,7 +4,7 @@
       PolicyName: (string) "",
       PolicyDSRID: (string) (len=5) "DSR-5",
       PolicyDisplayId: (string) (len=17) "ruby_rails_logger",
-      PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.",
+      PolicyDescription: (string) (len=44) "Do not send sensitive data to Rails loggers.",
       LineNumber: (int) 1,
       Filename: (string) (len=20) "pkg/datatype_leak.rb",
       CategoryGroups: ([]string) (len=2) {
@@ -20,7 +20,7 @@
       PolicyName: (string) "",
       PolicyDSRID: (string) (len=5) "DSR-5",
       PolicyDisplayId: (string) (len=17) "ruby_rails_logger",
-      PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.",
+      PolicyDescription: (string) (len=44) "Do not send sensitive data to Rails loggers.",
       LineNumber: (int) 2,
       Filename: (string) (len=20) "pkg/datatype_leak.rb",
       CategoryGroups: ([]string) (len=2) {

diff --git a/pkg/report/output/summary/.snapshots/TestSummaryWithSeverity b/pkg/report/output/summary/.snapshots/TestSummaryWithSeverity
@@ -4,7 +4,7 @@
       PolicyName: (string) "",
       PolicyDSRID: (string) (len=5) "DSR-5",
       PolicyDisplayId: (string) (len=17) "ruby_rails_logger",
-      PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.",
+      PolicyDescription: (string) (len=44) "Do not send sensitive data to Rails loggers.",
       LineNumber: (int) 1,
       Filename: (string) (len=20) "pkg/datatype_leak.rb",
       CategoryGroups: ([]string) (len=2) {
@@ -20,7 +20,7 @@
       PolicyName: (string) "",
       PolicyDSRID: (string) (len=5) "DSR-5",
       PolicyDisplayId: (string) (len=17) "ruby_rails_logger",
-      PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.",
+      PolicyDescription: (string) (len=44) "Do not send sensitive data to Rails loggers.",
       LineNumber: (int) 2,
       Filename: (string) (len=20) "pkg/datatype_leak.rb",
       CategoryGroups: ([]string) (len=2) {