rastating/wordpress-exploit-framework

View on GitHub
lib/wpxf/modules/exploit/shell/photo_gallery_shell_upload.rb

Summary

Maintainability
A
3 hrs
Test Coverage

Assignment Branch Condition size for run is too high. [40.1/15]
Open

  def run
    return false unless super

    cookie = authenticate_with_wordpress(username, password)
    return false unless cookie

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Cyclomatic complexity for run is too high. [9/6]
Open

  def run
    return false unless super

    cookie = authenticate_with_wordpress(username, password)
    return false unless cookie

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Perceived complexity for run is too high. [10/7]
Open

  def run
    return false unless super

    cookie = authenticate_with_wordpress(username, password)
    return false unless cookie

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Assignment Branch Condition size for extract_name_from_res is too high. [16.79/15]
Open

  def extract_name_from_res(res)
    begin
      json = JSON.parse(res.body)
      if json.nil? || json['files'].nil? || json['files'][0].nil? || json['files'][0]['name'].nil?
        return nil

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

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

  def run
    return false unless super

    cookie = authenticate_with_wordpress(username, password)
    return false unless cookie
Severity: Minor
Found in lib/wpxf/modules/exploit/shell/photo_gallery_shell_upload.rb - About 1 hr to fix

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

      def initialize
        super
    
        update_info(
          name: 'Photo Gallery Shell Upload',
    Severity: Minor
    Found in lib/wpxf/modules/exploit/shell/photo_gallery_shell_upload.rb - About 1 hr to fix

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

        def run
          return false unless super
      
          cookie = authenticate_with_wordpress(username, password)
          return false unless cookie
      Severity: Minor
      Found in lib/wpxf/modules/exploit/shell/photo_gallery_shell_upload.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

      Operator = should be surrounded by a single space.
      Open

          zipped_files =  { "#{name}.php" => payload.encoded }

      Checks that operators have space around them, except for ** which should not have surrounding space.

      Example:

      # bad
      total = 3*4
      "apple"+"juice"
      my_number = 38/4
      a ** b
      
      # good
      total = 3 * 4
      "apple" + "juice"
      my_number = 38 / 4
      a**b

      Avoid rescuing without specifying an error class.
      Open

          rescue

      This cop checks for rescuing StandardError. There are two supported styles implicit and explicit. This cop will not register an offense if any error other than StandardError is specified.

      Example: EnforcedStyle: implicit

      # `implicit` will enforce using `rescue` instead of
      # `rescue StandardError`.
      
      # bad
      begin
        foo
      rescue StandardError
        bar
      end
      
      # good
      begin
        foo
      rescue
        bar
      end
      
      # good
      begin
        foo
      rescue OtherError
        bar
      end
      
      # good
      begin
        foo
      rescue StandardError, SecurityError
        bar
      end

      Example: EnforcedStyle: explicit (default)

      # `explicit` will enforce using `rescue StandardError`
      # instead of `rescue`.
      
      # bad
      begin
        foo
      rescue
        bar
      end
      
      # good
      begin
        foo
      rescue StandardError
        bar
      end
      
      # good
      begin
        foo
      rescue OtherError
        bar
      end
      
      # good
      begin
        foo
      rescue StandardError, SecurityError
        bar
      end

      Do not suppress exceptions.
      Open

          rescue

      This cop checks for rescue blocks with no body.

      Example:

      # bad
      
      def some_method
        do_something
      rescue
        # do nothing
      end

      Example:

      # bad
      
      begin
        do_something
      rescue
        # do nothing
      end

      Example:

      # good
      
      def some_method
        do_something
      rescue
        handle_exception
      end

      Example:

      # good
      
      begin
        do_something
      rescue
        handle_exception
      end

      Unnecessary spacing detected.
      Open

          zipped_files =  { "#{name}.php" => payload.encoded }

      This cop checks for extra/unnecessary whitespace.

      Example:

      # good if AllowForAlignment is true
      name      = "RuboCop"
      # Some comment and an empty line
      
      website  += "/bbatsov/rubocop" unless cond
      puts        "rubocop"          if     debug
      
      # bad for any configuration
      set_app("RuboCop")
      website  = "https://github.com/bbatsov/rubocop"

      Use a guard clause instead of wrapping the code inside a conditional expression.
      Open

            if json.nil? || json['files'].nil? || json['files'][0].nil? || json['files'][0]['name'].nil?

      Use a guard clause instead of wrapping the code inside a conditional expression

      Example:

      # bad
      def test
        if something
          work
        end
      end
      
      # good
      def test
        return unless something
        work
      end
      
      # also good
      def test
        work if something
      end
      
      # bad
      if something
        raise 'exception'
      else
        ok
      end
      
      # good
      raise 'exception' if something
      ok

      There are no issues that match your filters.

      Category
      Status