rapid7/metasploit-framework

View on GitHub
modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb

Summary

Maintainability
D
2 days
Test Coverage

Method run_host has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
Open

  def run_host(ip)
    print_status("#{ip}:#{rport} SSH - Testing Cleartext Keys")

    if datastore["USER_FILE"].blank? && datastore["USERNAME"].blank?
      validation_reason = "At least one of USER_FILE or USERNAME must be given"
Severity: Minor
Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.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 valid? has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
Open

    def valid?
      @error_list = []
      @key_data = Set.new

      unless @private_key.present? || @key_path.present?
Severity: Minor
Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb - About 3 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_host has 94 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def run_host(ip)
    print_status("#{ip}:#{rport} SSH - Testing Cleartext Keys")

    if datastore["USER_FILE"].blank? && datastore["USERNAME"].blank?
      validation_reason = "At least one of USER_FILE or USERNAME must be given"
Severity: Major
Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb - About 3 hrs to fix

    File ssh_login_pubkey.rb has 259 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require 'net/ssh'
    require 'metasploit/framework/login_scanner/ssh'
    require 'metasploit/framework/credential_collection'
    require 'sshkey'
    require 'net/ssh/command_stream'
    Severity: Minor
    Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb - About 2 hrs to fix

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

        def initialize
          super(
            'Name'        => 'SSH Public Key Login Scanner',
            'Description' => %q{
              This module will test ssh logins on a range of machines using
      Severity: Minor
      Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb - About 1 hr to fix

        Method valid? has 36 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            def valid?
              @error_list = []
              @key_data = Set.new
        
              unless @private_key.present? || @key_path.present?
        Severity: Minor
        Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb - About 1 hr to fix

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

              scanner = Metasploit::Framework::LoginScanner::SSH.new(
                configure_login_scanner(
                  host: ip,
                  port: rport,
                  cred_details: keys,
          Severity: Minor
          Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb and 1 other location - About 45 mins to fix
          modules/auxiliary/scanner/ssh/ssh_login.rb on lines 100..112

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

          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 2 locations. Consider refactoring.
          Open

                    if datastore['GatherProof'] && scanner.get_platform(result.proof) == 'unknown'
                      msg = "While a session may have opened, it may be bugged.  If you experience issues with it, re-run this module with"
                      msg << " 'set gatherproof false'.  Also consider submitting an issue at github.com/rapid7/metasploit-framework with"
                      msg << " device details so it can be handled in the future."
                      print_brute :level => :error, :ip => ip, :msg => msg
          Severity: Minor
          Found in modules/auxiliary/scanner/ssh/ssh_login_pubkey.rb and 1 other location - About 20 mins to fix
          modules/auxiliary/scanner/ssh/ssh_login.rb on lines 140..145

          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