rapid7/metasploit-framework

View on GitHub
lib/msf/core/auxiliary/ubiquiti.rb

Summary

Maintainability
D
2 days
Test Coverage

Method process_setting has a Cognitive Complexity of 53 (exceeds 5 allowed). Consider refactoring.
Open

      def process_setting(lines, credential_data)
        lines.each do |line|
          case line['key']
          when 'snmp'
            if framework.db.active
Severity: Minor
Found in lib/msf/core/auxiliary/ubiquiti.rb - About 1 day 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 unifi_config_eater has 186 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def unifi_config_eater(thost, tport, config)
      # This is for the Ubiquiti Unifi files.  These are typically in the backup download zip file
      # then in the db.gz file as db.  It is a MongoDB BSON file, which can be difficult to read.
      # https://stackoverflow.com/questions/51242412/undefined-method-read-bson-document-for-bsonmodule
      # The BSON file is a bunch of BSON Documents chained together.  There doesn't seem to be a good
Severity: Major
Found in lib/msf/core/auxiliary/ubiquiti.rb - About 7 hrs to fix

    Method process_firewallrule has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

          def process_firewallrule(lines, _)
            lines.each do |line|
              rule = (line['action']).to_s
              unless line['dst_address'].empty?
                rule << " dst addresses: #{line['dst_address']}"
    Severity: Minor
    Found in lib/msf/core/auxiliary/ubiquiti.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 process_radiusprofile has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

          def process_radiusprofile(lines, credential_data)
            lines.each do |line|
              line['auth_servers'].each do |server|
                report_service(
                  host: server['ip'],
    Severity: Minor
    Found in lib/msf/core/auxiliary/ubiquiti.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 bson_to_json has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def bson_to_json(byte_buffer)
          # This function takes a byte buffer (db file from Unifi read in), which is a bson string
          # it then converts it to JSON, where it uses the 'select collection' documents
          # as keys.  For instance a bson that contained the follow (displayed in json
          # for ease):
    Severity: Minor
    Found in lib/msf/core/auxiliary/ubiquiti.rb - About 35 mins 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 process_wlanconf has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

          def process_wlanconf(lines, credential_data)
            lines.each do |line|
              ssid = line['name']
              mode = line['security']
              password = line['x_passphrase']
    Severity: Minor
    Found in lib/msf/core/auxiliary/ubiquiti.rb - About 35 mins 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 extract_and_process_db has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def extract_and_process_db(db_path)
          f = nil
          Zip::File.open(db_path) do |zip_file|
            # Handle entries one by one
            zip_file.each do |entry|
    Severity: Minor
    Found in lib/msf/core/auxiliary/ubiquiti.rb - About 25 mins 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

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

          if framework.db.active
            creds_template = {
              address: thost,
              port: tport,
              protocol: 'tcp',
    Severity: Major
    Found in lib/msf/core/auxiliary/ubiquiti.rb and 5 other locations - About 20 mins to fix
    lib/msf/core/auxiliary/brocade.rb on lines 53..64
    lib/msf/core/auxiliary/cisco.rb on lines 38..49
    lib/msf/core/auxiliary/juniper.rb on lines 151..162
    lib/msf/core/auxiliary/mikrotik.rb on lines 81..92
    lib/msf/core/auxiliary/mikrotik.rb on lines 176..187

    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