rastating/wordpress-exploit-framework

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

Summary

Maintainability
A
2 hrs
Test Coverage

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

  def run
    super
    return false unless check_wordpress_and_online

    emit_info 'Preparing payload...'

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
    super
    return false unless check_wordpress_and_online

    emit_info 'Preparing payload...'

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. [9/7]
Open

  def run
    super
    return false unless check_wordpress_and_online

    emit_info 'Preparing payload...'

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

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

  def run
    super
    return false unless check_wordpress_and_online

    emit_info 'Preparing payload...'
Severity: Minor
Found in lib/wpxf/modules/exploit/shell/revslider_shell_upload.rb - About 1 hr to fix

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

      def run
        super
        return false unless check_wordpress_and_online
    
        emit_info 'Preparing payload...'
    Severity: Minor
    Found in lib/wpxf/modules/exploit/shell/revslider_shell_upload.rb - About 45 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

    Avoid too many return statements within this method.
    Open

        return true
    Severity: Major
    Found in lib/wpxf/modules/exploit/shell/revslider_shell_upload.rb - About 30 mins to fix

      Use match? instead of =~ when MatchData is not used.
      Open

          if res.body =~ /^0$/

      In Ruby 2.4, String#match?, Regexp#match? and Symbol#match? have been added. The methods are faster than match. Because the methods avoid creating a MatchData object or saving backref. So, when MatchData is not used, use match? instead of match.

      Example:

      # bad
      def foo
        if x =~ /re/
          do_something
        end
      end
      
      # bad
      def foo
        if x.match(/re/)
          do_something
        end
      end
      
      # bad
      def foo
        if /re/ === x
          do_something
        end
      end
      
      # good
      def foo
        if x.match?(/re/)
          do_something
        end
      end
      
      # good
      def foo
        if x =~ /re/
          do_something(Regexp.last_match)
        end
      end
      
      # good
      def foo
        if x.match(/re/)
          do_something($~)
        end
      end
      
      # good
      def foo
        if /re/ === x
          do_something($~)
        end
      end

      Redundant return detected.
      Open

          return true

      This cop checks for redundant return expressions.

      Example:

      def test
        return something
      end
      
      def test
        one
        two
        three
        return something
      end

      It should be extended to handle methods whose body is if/else or a case expression with a default branch.

      There are no issues that match your filters.

      Category
      Status