rapid7/metasploit-framework

View on GitHub
lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb

Summary

Maintainability
F
3 days
Test Coverage

Method build_packet_and_layouts has a Cognitive Complexity of 54 (exceeds 5 allowed). Consider refactoring.
Open

  def build_packet_and_layouts(packet, function, args, arch)
    case arch
    when ARCH_X64
      native = 'Q<'
    when ARCH_X86
Severity: Minor
Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.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 build_packet_and_layouts has 103 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def build_packet_and_layouts(packet, function, args, arch)
    case arch
    when ARCH_X64
      native = 'Q<'
    when ARCH_X86
Severity: Major
Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb - About 4 hrs to fix

    Method build_response has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

      def build_response(packet, function, layouts, client)
        case client.native_arch
        when ARCH_X64
          native = 'Q<'
        when ARCH_X86
    Severity: Minor
    Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb - About 4 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 build_response has 87 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def build_response(packet, function, layouts, client)
        case client.native_arch
        when ARCH_X64
          native = 'Q<'
        when ARCH_X86
    Severity: Major
    Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb - About 3 hrs to fix

      File library.rb has 275 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      require 'rex/post/meterpreter/extensions/stdapi/railgun/library_function'
      require 'rex/post/meterpreter/extensions/stdapi/railgun/library_helper'
      require 'rex/post/meterpreter/extensions/stdapi/railgun/buffer_item'
      require 'rex/post/meterpreter/extensions/stdapi/railgun/tlv'
      require 'rex/post/meterpreter/packet'
      Severity: Minor
      Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb - About 2 hrs to fix

        Avoid deeply nested control flow statements.
        Open

                    if buffer_size != 4
                      raise "Please pass 4 for 'out' PULONG_PTR, since they require a buffer of size 4"
                    end
        Severity: Major
        Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb - About 45 mins to fix

          Method add_function has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            def add_function(name, return_type, params, remote_name=nil, calling_conv='stdcall')
          Severity: Minor
          Found in lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb - About 35 mins to fix

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

                layouts[:out].each_pair do |param_name, buffer_item|
                  buffer = rec_out_only_buffers[buffer_item.addr, buffer_item.length_in_bytes]
                  case buffer_item.datatype
                    when 'PULONG_PTR'
                      return_hash[param_name] = buffer.unpack(native).first
            lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb on lines 362..376

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

            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

                layouts[:inout].each_pair do |param_name, buffer_item|
                  buffer = rec_inout_buffers[buffer_item.addr, buffer_item.length_in_bytes]
                  case buffer_item.datatype
                    when 'PULONG_PTR'
                      return_hash[param_name] = buffer.unpack(native).first
            lib/rex/post/meterpreter/extensions/stdapi/railgun/library.rb on lines 343..357

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

            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