rapid7/metasploit-framework

View on GitHub
modules/post/windows/gather/word_unc_injector.rb

Summary

Maintainability
C
1 day
Test Coverage

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

  def run
    # sadly OptPath does not work, so we check manually if it exists
    if !file_exist?(datastore['FILE'])
      print_error('Remote file does not exist!')
      return
Severity: Major
Found in modules/post/windows/gather/word_unc_injector.rb - About 2 hrs to fix

    Method manipulate_file has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

      def manipulate_file(zipfile)
        ref = '<w:attachedTemplate r:id="rId1"/>'
    
        rels_file_data = ''
        rels_file_data << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
    Severity: Minor
    Found in modules/post/windows/gather/word_unc_injector.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 manipulate_file has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def manipulate_file(zipfile)
        ref = '<w:attachedTemplate r:id="rId1"/>'
    
        rels_file_data = ''
        rels_file_data << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
    Severity: Minor
    Found in modules/post/windows/gather/word_unc_injector.rb - About 1 hr to fix

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

        def initialize(info = {})
          super(
            update_info(
              info,
              'Name' => 'Windows Gather Microsoft Office Word UNC Path Injector',
      Severity: Minor
      Found in modules/post/windows/gather/word_unc_injector.rb - About 1 hr to fix

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

          def run
            # sadly OptPath does not work, so we check manually if it exists
            if !file_exist?(datastore['FILE'])
              print_error('Remote file does not exist!')
              return
        Severity: Minor
        Found in modules/post/windows/gather/word_unc_injector.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

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

              report_note(
                host: session.session_host,
                type: 'host.word_unc_injector.changedfiles',
                data: {
                  session_num: session.sid,
        Severity: Minor
        Found in modules/post/windows/gather/word_unc_injector.rb and 1 other location - About 30 mins to fix
        modules/exploits/windows/local/s4u_persistence.rb on lines 346..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 33.

        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 insert_one.nil?
                insert_two = file_content.index('<w:hyphenationZone') # 2nd choice
                if !insert_two.nil?
                  vprint_status('HypenationZone found, we use this for insertion.')
                  file_content.insert(insert_two, ref)
        Severity: Minor
        Found in modules/post/windows/gather/word_unc_injector.rb and 1 other location - About 15 mins to fix
        modules/auxiliary/docx/word_unc_injector.rb on lines 120..128

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

        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