rapid7/metasploit-framework

View on GitHub
modules/post/windows/capture/keylog_recorder.rb

Summary

Maintainability
D
1 day
Test Coverage

File keylog_recorder.rb has 278 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'English'
class MetasploitModule < Msf::Post
  include Msf::Post::Windows::Priv
  include Msf::Post::Windows::Process
  include Msf::Post::File
Severity: Minor
Found in modules/post/windows/capture/keylog_recorder.rb - About 2 hrs to fix

    Method initialize has 59 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def initialize(info = {})
        super(
          update_info(
            info,
            'Name' => 'Windows Capture Keystroke Recorder',
    Severity: Major
    Found in modules/post/windows/capture/keylog_recorder.rb - About 2 hrs to fix

      Method keycap has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

        def keycap
          rec = 1
          print_status("Keystrokes being saved in to #{@logfile}")
          print_status('Recording keystrokes...')
      
      
      Severity: Minor
      Found in modules/post/windows/capture/keylog_recorder.rb - About 2 hrs to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Method run has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

        def run
          print_status("Executing module against #{sysinfo['Computer']}")
          if datastore['MIGRATE']
            if datastore['CAPTURE_TYPE'] == 'pid'
              return unless migrate_pid(datastore['PID'], session.sys.process.getpid)
      Severity: Minor
      Found in modules/post/windows/capture/keylog_recorder.rb - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Method keycap has 34 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        def keycap
          rec = 1
          print_status("Keystrokes being saved in to #{@logfile}")
          print_status('Recording keystrokes...')
      
      
      Severity: Minor
      Found in modules/post/windows/capture/keylog_recorder.rb - About 1 hr to fix

        Avoid too many return statements within this method.
        Open

              return false
        Severity: Major
        Found in modules/post/windows/capture/keylog_recorder.rb - About 30 mins to fix

          Similar blocks of code found in 2 locations. Consider refactoring.
          Open

              begin
                client.core.migrate(target_pid)
                print_good("Successfully migrated to #{client.sys.process.open.name} (#{client.sys.process.open.pid}) as: #{client.sys.config.getuid}")
                return true
              rescue Rex::Post::Meterpreter::RequestError => e
          Severity: Minor
          Found in modules/post/windows/capture/keylog_recorder.rb and 1 other location - About 1 hr to fix
          modules/post/windows/capture/keylog_recorder.rb on lines 237..245

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 47.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Similar blocks of code found in 2 locations. Consider refactoring.
          Open

              begin
                client.core.migrate(target_pid)
                print_good("Successfully migrated to #{client.sys.process.open.name} (#{client.sys.process.open.pid}) as: #{client.sys.config.getuid}")
                return true
              rescue Rex::Post::Meterpreter::RequestError => e
          Severity: Minor
          Found in modules/post/windows/capture/keylog_recorder.rb and 1 other location - About 1 hr to fix
          modules/post/windows/capture/keylog_recorder.rb on lines 204..212

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 47.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Identical blocks of code found in 3 locations. Consider refactoring.
          Open

              if target_pid == current_pid
                print_good("Already in #{client.sys.process.open.name} (#{client.sys.process.open.pid}) as: #{client.sys.config.getuid}")
                return true
          Severity: Minor
          Found in modules/post/windows/capture/keylog_recorder.rb and 2 other locations - About 20 mins to fix
          modules/post/windows/capture/keylog_recorder.rb on lines 232..234
          modules/post/windows/manage/priv_migrate.rb on lines 117..119

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 28.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Identical blocks of code found in 3 locations. Consider refactoring.
          Open

              if target_pid == current_pid
                print_good("Already in #{client.sys.process.open.name} (#{client.sys.process.open.pid}) as: #{client.sys.config.getuid}")
                return true
          Severity: Minor
          Found in modules/post/windows/capture/keylog_recorder.rb and 2 other locations - About 20 mins to fix
          modules/post/windows/capture/keylog_recorder.rb on lines 199..201
          modules/post/windows/manage/priv_migrate.rb on lines 117..119

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 28.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          There are no issues that match your filters.

          Category
          Status