rapid7/metasploit-framework

View on GitHub
lib/msf/core/db_manager/import/metasploit_framework/zip.rb

Summary

Maintainability
F
3 days
Test Coverage

Method import_msf_zip has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
Open

  def import_msf_zip(args={}, &block)
    data = args[:data]
    wspace = Msf::Util::DBManager.process_opts_workspace(args, framework)
    bl = validate_ips(args[:blacklist]) ? args[:blacklist].split : []

Severity: Minor
Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 5 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 parse_zip_loot has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

  def parse_zip_loot(loot, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
    return 0 if bl.include? host_info[loot.at("host-id").text.to_s.strip]
    loot_info              = {}
    loot_info[:host]       = host_info[loot.at("host-id").text.to_s.strip]
    loot_info[:workspace]  = wspace
Severity: Minor
Found in lib/msf/core/db_manager/import/metasploit_framework/zip.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 parse_zip_task has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

  def parse_zip_task(task, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
    task_info = {}
    task_info[:workspace] = wspace
    # Should user be imported (original) or declared (the importing user)?
    task_info[:user] = nils_for_nulls(task.at("created-by").text.to_s.strip)
Severity: Minor
Found in lib/msf/core/db_manager/import/metasploit_framework/zip.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 import_msf_zip has 58 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def import_msf_zip(args={}, &block)
    data = args[:data]
    wspace = Msf::Util::DBManager.process_opts_workspace(args, framework)
    bl = validate_ips(args[:blacklist]) ? args[:blacklist].split : []

Severity: Major
Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 2 hrs to fix

    Method parse_zip_task has 42 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def parse_zip_task(task, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
        task_info = {}
        task_info[:workspace] = wspace
        # Should user be imported (original) or declared (the importing user)?
        task_info[:user] = nils_for_nulls(task.at("created-by").text.to_s.strip)
    Severity: Minor
    Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

      Method import_msf_collateral has 41 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        def import_msf_collateral(args={}, &block)
          data = ::File.open(args[:filename], "rb") {|f| f.read(f.stat.size)}
          wspace = Msf::Util::DBManager.process_opts_workspace(args, framework)
          args = args.clone()
          args.delete(:workspace)
      Severity: Minor
      Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

        Method parse_zip_loot has 40 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          def parse_zip_loot(loot, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
            return 0 if bl.include? host_info[loot.at("host-id").text.to_s.strip]
            loot_info              = {}
            loot_info[:host]       = host_info[loot.at("host-id").text.to_s.strip]
            loot_info[:workspace]  = wspace
        Severity: Minor
        Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

          Method import_msf_collateral has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
          Open

            def import_msf_collateral(args={}, &block)
              data = ::File.open(args[:filename], "rb") {|f| f.read(f.stat.size)}
              wspace = Msf::Util::DBManager.process_opts_workspace(args, framework)
              args = args.clone()
              args.delete(:workspace)
          Severity: Minor
          Found in lib/msf/core/db_manager/import/metasploit_framework/zip.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 parse_zip_host has 9 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            def parse_zip_host(host, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
          Severity: Major
          Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

            Method parse_zip_task has 9 arguments (exceeds 4 allowed). Consider refactoring.
            Open

              def parse_zip_task(task, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
            Severity: Major
            Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

              Method parse_zip_report has 9 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                def parse_zip_report(report, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
              Severity: Major
              Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

                Method parse_zip_loot has 9 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                  def parse_zip_loot(loot, wspace, bl, allow_yaml, btag, args, basedir, host_info, &block)
                Severity: Major
                Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb - About 1 hr to fix

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

                      if ::File.exist? loot_info[:orig_path]
                        loot_dir = ::File.join(basedir,"loot")
                        loot_file = ::File.split(loot_info[:orig_path]).last
                        if ::File.exist? loot_dir
                          unless (::File.directory?(loot_dir) && ::File.writable?(loot_dir))
                  Severity: Major
                  Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb and 1 other location - About 1 hr to fix
                  lib/msf/core/db_manager/import/metasploit_framework/zip.rb on lines 132..150

                  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 70.

                  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

                      if ::File.exist? task_info[:orig_path]
                        tasks_dir = ::File.join(basedir,"tasks")
                        task_file = ::File.split(task_info[:orig_path]).last
                        if ::File.exist? tasks_dir
                          unless (::File.directory?(tasks_dir) && ::File.writable?(tasks_dir))
                  Severity: Major
                  Found in lib/msf/core/db_manager/import/metasploit_framework/zip.rb and 1 other location - About 1 hr to fix
                  lib/msf/core/db_manager/import/metasploit_framework/zip.rb on lines 82..100

                  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 70.

                  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