Update info -d markdown

Author: cgranleese-r7

data/markdown_doc/default_template.erb

@@ -67,6 +67,8 @@
 <% description = "Module may cause a noise (Examples: audio output from the speakers or hardware beeps)." %>
 <% elsif side_effect == "physical-effects" %>
 <% description = "Module may produce physical effects (Examples: the device makes movement or flashes LEDs)." %>
+<% elsif side_effect == "unknown-side-effects" %>
+<% description = "Module side effects are unknown." %>
 <% end %>
 
 * **<%= side_effect %>:** <%= description %>
@@ -85,6 +87,8 @@
 <% description = "The module isn't expected to get a shell reliably (such as only once)." %>
 <% elsif reliability == "event-dependent" %>
 <% description = "The module may not execute the payload until an external event occurs. For instance, a cron job, machine restart, user interaction within a GUI element, etc." %>
+<% elsif reliability == "unknown-reliability" %>
+<% description = "Module reliability is unknown." %>
 <% end %>
 
 * **<%= reliability %>:** <%= description %>
@@ -109,6 +113,8 @@
 <% description = "Module may cause a resource (such as a file or data in a database) to be unavailable for the service." %>
 <% elsif stability == "os-resource-loss" %>
 <% description = "Modules may cause a resource (such as a file) to be unavailable for the OS." %>
+<% elsif stability == "unknown-stability" %>
+<% description = "Module stability is unknown." %>
 <% end %>
 
 * **<%= stability %>:** <%= description %>

lib/msf/core/constants.rb

@@ -55,8 +55,8 @@ module Msf
 # Stability traits
 #
 
-# Module stability is unknown.
-UNKNOWN_STABILITY = 'unknown-stability'
+# Module stability is unknown - this is a sentinel value, and is not a valid stability enum value
+UNKNOWN_STABILITY      = ['unknown-stability']
 # Module should not crash the service.
 CRASH_SAFE             = 'crash-safe'
 # Module may crash the service, but the service restarts.
@@ -76,8 +76,8 @@ module Msf
 # Side-effect traits
 #
 
-# Module side effects are unknown.
-UNKNOWN_SIDE_EFFECTS = 'unknown-side-effects'
+# Module side effects is unknown - this is a sentinel value, and is not a valid side effect enum value
+UNKNOWN_SIDE_EFFECTS = ['unknown-side-effects']
 # Modules leaves a payload or a dropper on the target machine.
 ARTIFACTS_ON_DISK = 'artifacts-on-disk'
 # Module modifies some configuration setting on the target machine.
@@ -99,8 +99,8 @@ module Msf
 # Reliability
 #
 
-# Module reliability is unknown.
-UNKNOWN_RELIABILITY = 'unknown-reliability'
+# Module reliability is unknown - this is a sentinel value, and is not a valid reliability enum value
+UNKNOWN_RELIABILITY = ['unknown-reliability']
 # The module tends to fail to get a session on the first attempt.
 FIRST_ATTEMPT_FAIL = 'first-attempt-fail'
 # The module is expected to get a shell every time it runs.

lib/rubocop/cop/lint/module_enforce_notes.rb

@@ -46,19 +46,49 @@ def on_def(node)
         private
 
         def insert_notes_autocorrect(corrector, hash)
+          indent, last_pair = calculate_indent(hash)
+          corrector.insert_after(last_pair.loc.expression, notes_formatted(indent))
+        end
+
+        # def insert_notes_keys_autocorrect(corrector, hash)
+        #   indent, last_pair = calculate_indent(hash)
+        #   corrector.insert_after(last_pair.loc.expression, notes_formatted(indent))
+        # end
+
+        # def insert_missing_notes_keys(corrector, missing_keys, notes)
+        #   indent, last_pair = calculate_indent(notes)
+        #   corrector.insert_after(last_pair.loc.expression, keys_formatted(indent, missing_keys))
+        # end
+
+        def calculate_indent(hash)
           last_pair = hash.pairs.last
           indent_width = last_pair.loc.expression.column
-          indent = ' ' * indent_width
-          corrector.insert_after(last_pair.loc.expression, notes_formatted(indent))
+          [' ' * indent_width, last_pair]
         end
 
+        # def keys_formatted(indent, missing_keys)
+        #   keys_to_insert = []
+        #   missing_keys.each do |key|
+        #     case key
+        #     when 'Reliability'
+        #       keys_to_insert << "#{indent}'Reliability' => UNKNOWN_RELIABILITY"
+        #     when 'Stability'
+        #       keys_to_insert << "#{indent}'Stability' => UNKNOWN_STABILITY"
+        #     when 'SideEffects'
+        #       keys_to_insert << "#{indent}'SideEffects' => UNKNOWN_SIDE_EFFECTS"
+        #     end
+        #   end
+        #
+        #   ",\n#{keys_to_insert.join(",\n")}"
+        # end
+
         def notes_formatted(indent)
           <<~EOF.strip
             ,
             #{indent}'Notes' => {
-            #{indent}  'Reliability' => [UNKNOWN_RELIABILITY],
-            #{indent}  'Stability' => [UNKNOWN_STABILITY],
-            #{indent}  'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+            #{indent}  'Reliability' => UNKNOWN_RELIABILITY,
+            #{indent}  'Stability' => UNKNOWN_STABILITY,
+            #{indent}  'SideEffects' => UNKNOWN_SIDE_EFFECTS
             #{indent}}
           EOF
         end
@@ -81,6 +111,10 @@ def check_for_required_keys(notes)
               msg = missing_keys[0...-1].join(', ') + ' and ' + missing_keys[-1]
             end
             add_offense(last_key || notes, message: MISSING_KEY_MSG % msg)
+
+            # add_offense(last_key || notes, message: MISSING_KEY_MSG % msg) do |corrector|
+            #   insert_missing_notes_keys(corrector, missing_keys, notes)
+            # end
           end
         end
 

modules/auxiliary/fileformat/badpdf.rb

@@ -29,9 +29,9 @@ def initialize(info = {})
           ['URL', 'https://research.checkpoint.com/ntlm-credentials-theft-via-pdf-files/']
         ],
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
       )

modules/auxiliary/gather/advantech_webaccess_creds.rb

@@ -28,9 +28,9 @@ def initialize(info = {})
         ],
         'DisclosureDate' => '2017-01-21',
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
     )

modules/auxiliary/gather/alienvault_iso27001_sqli.rb

@@ -31,9 +31,9 @@ def initialize(info = {})
         'Privileged' => false,
         'DisclosureDate' => '2014-03-30',
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
     )

modules/auxiliary/gather/alienvault_newpolicyform_sqli.rb

@@ -33,9 +33,9 @@ def initialize(info = {})
         'Privileged' => false,
         'DisclosureDate' => '2014-05-09',
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
     )

modules/auxiliary/gather/android_browser_file_theft.rb

@@ -31,9 +31,9 @@ def initialize(info = {})
         ],
         'DefaultAction' => 'WebServer',
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
     )

modules/auxiliary/gather/android_browser_new_tab_cookie_theft.rb

@@ -36,9 +36,9 @@ def initialize(info = {})
         ],
         'DefaultAction' => 'WebServer',
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
     )

modules/auxiliary/gather/android_htmlfileprovider.rb

@@ -33,9 +33,9 @@ def initialize(info = {})
         ],
         'DefaultAction' => 'WebServer',
         'Notes' => {
-          'Reliability' => [UNKNOWN_RELIABILITY],
-          'Stability' => [UNKNOWN_STABILITY],
-          'SideEffects' => [UNKNOWN_SIDE_EFFECTS]
+          'Reliability' => UNKNOWN_RELIABILITY,
+          'Stability' => UNKNOWN_STABILITY,
+          'SideEffects' => UNKNOWN_SIDE_EFFECTS
         }
       )
     )