rapid7/metasploit-framework

View on GitHub
modules/auxiliary/gather/office365userenum.py

Summary

Maintainability
F
3 days
Test Coverage

File office365userenum.py has 402 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#! /usr/bin/env python3
# -*- coding: utf-8 -*-
from __future__ import print_function

'''
Severity: Minor
Found in modules/auxiliary/gather/office365userenum.py - About 5 hrs to fix

    Function report has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring.
    Open

    def report(out_q, output_file):
        """Thread worker function. Output to terminal and file."""
        msf_template = "{code} {valid} {user}:{password}"
        template = "[{s}] {code} {valid} {user}:{password}"
        symbols = {
    Severity: Minor
    Found in modules/auxiliary/gather/office365userenum.py - 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

    Function check_users has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
    Open

    def check_users(in_q, out_q, url, password, timeout):
        """Thread worker function which retrieves candidate username from input queue runs the check_user function and
        outputs the result to the output queue."""
        while not SHUTDOWN_EVENT.is_set():
            try:
    Severity: Minor
    Found in modules/auxiliary/gather/office365userenum.py - 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

    Function main has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    def main(args):
        """Setup worker threads and handle shutdown."""
        user_file = args['users']
        output_file = args['output']
        url = args['url']
    Severity: Minor
    Found in modules/auxiliary/gather/office365userenum.py - 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

    Function check_user has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def check_user(url, user, password, timeout):
        """Exploit the difference in HTTP responses from the ActiveSync service to identify valid and invalid usernames.
        It was also identified that valid accounts with 2FA enabled can be distinguished from valid accounts without 2FA."""
        headers = {"MS-ASProtocolVersion": "14.0"}
        auth = (user, password)
    Severity: Minor
    Found in modules/auxiliary/gather/office365userenum.py - 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

    Function setup_logging has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def setup_logging(verbose=True, log_file=None):
        """Configure logging."""
        if log_file is not None:
            logging.basicConfig(level=logging.DEBUG,
                                format="%(asctime)s: %(levelname)s: %(module)s: %(message)s",
    Severity: Minor
    Found in modules/auxiliary/gather/office365userenum.py - 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

    Function check_users has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def check_users(in_q, out_q, url, password, timeout):
    Severity: Minor
    Found in modules/auxiliary/gather/office365userenum.py - About 35 mins to fix

      Function get_users has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      def get_users(user_file, in_q, max_threads):
          """Thread worker function. Load candidate usernames from file into input queue."""
          with open(user_file, "r") as f:
              for line in f:
                  if SHUTDOWN_EVENT.is_set():
      Severity: Minor
      Found in modules/auxiliary/gather/office365userenum.py - 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

      Avoid too many return statements within this function.
      Open

              return user, password, VALID_LOGIN, r
      Severity: Major
      Found in modules/auxiliary/gather/office365userenum.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return user, password, UNKNOWN, r
        Severity: Major
        Found in modules/auxiliary/gather/office365userenum.py - About 30 mins to fix

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

                  try:
                      user = in_q.get()
                  except queue.Empty as e:
                      msg = "check_users: in_q empty"
                      if MSF:
          Severity: Major
          Found in modules/auxiliary/gather/office365userenum.py and 1 other location - About 2 hrs to fix
          modules/auxiliary/gather/office365userenum.py on lines 265..273

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

          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

                  try:
                      result = out_q.get()
                  except queue.Empty as e:
                      msg = "report: out_q empty"
                      if MSF:
          Severity: Major
          Found in modules/auxiliary/gather/office365userenum.py and 1 other location - About 2 hrs to fix
          modules/auxiliary/gather/office365userenum.py on lines 193..201

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

          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

                  if result == DIE:
                      out_q.task_done()
                      msg = "report thread dying."
                      if MSF:
                          module.log(msg, "debug")
          Severity: Major
          Found in modules/auxiliary/gather/office365userenum.py and 1 other location - About 1 hr to fix
          modules/auxiliary/gather/office365userenum.py on lines 202..209

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

          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

                  if user == DIE:
                      in_q.task_done()
                      msg = "check_users thread dying"
                      if MSF:
                          module.log(msg, "debug")
          Severity: Major
          Found in modules/auxiliary/gather/office365userenum.py and 1 other location - About 1 hr to fix
          modules/auxiliary/gather/office365userenum.py on lines 274..281

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

          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