Sign upLogin

failmap/admin

View on GitHub
Star
websecmap/reporting/severity.py

Summary

Maintainability
D
2 days
Test Coverage

File severity.py has 467 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
Business logic that determines what points and calculations are stored.

This file contains (or should) verbose explantion of why points are given.
Severity: Minor
Found in websecmap/reporting/severity.py - About 7 hrs to fix

    Cyclomatic complexity is too high in function internet_nl_requirement_tilde_value_format. (11)
    Open

    def internet_nl_requirement_tilde_value_format(scan: Union[EndpointGenericScan, UrlGenericScan]):

    # To support old metrics:
    if "~" in scan.rating:
        return internet_nl_api_v1_requirement_tilde_value_format(scan)
    Severity: Minor
    Found in websecmap/reporting/severity.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in function internet_nl_api_v1_requirement_tilde_value_format. (11)
    Open

    def internet_nl_api_v1_requirement_tilde_value_format(scan: Union[EndpointGenericScan, UrlGenericScan]):
    """
    See documentation of upgrade_api_response to learn how this parsing works.

    sept 2019:
    Severity: Minor
    Found in websecmap/reporting/severity.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in function get_security_header_calculation. (10)
    Open

    def get_security_header_calculation(scan: Union[EndpointGenericScan, UrlGenericScan]):
    """
    Rationale for classifcation

        # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
    Severity: Minor
    Found in websecmap/reporting/severity.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function internet_nl_api_v1_requirement_tilde_value_format has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def internet_nl_api_v1_requirement_tilde_value_format(scan: Union[EndpointGenericScan, UrlGenericScan]):
    """
    See documentation of upgrade_api_response to learn how this parsing works.

    sept 2019:
    Severity: Minor
    Found in websecmap/reporting/severity.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 get_security_header_calculation has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_security_header_calculation(scan: Union[EndpointGenericScan, UrlGenericScan]):
    """
    Rationale for classifcation

        # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
    Severity: Minor
    Found in websecmap/reporting/severity.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

    Cyclomatic complexity is too high in function internet_nl_score. (6)
    Open

    def internet_nl_score(scan: Union[EndpointGenericScan, UrlGenericScan]):
    # There might not be a score, but a test error.
    if scan.rating == "error":
        return standard_calculation(
            scan=scan, explanation=f"{scan.rating} {scan.evidence}", high=0, medium=0, low=0, error_in_test=True
    Severity: Minor
    Found in websecmap/reporting/severity.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Cyclomatic complexity is too high in function get_severity. (6)
    Open

    def get_severity(scan: Union[EndpointGenericScan, UrlGenericScan]) -> Dict[str, Any]:
    # Can be probably more efficient by adding some methods to scan.
    if not calculation_methods.get(scan.type, None):
        raise ValueError("No calculation available for this scan type: %s" % scan.type)
    Severity: Minor
    Found in websecmap/reporting/severity.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

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

    def internet_nl_requirement_tilde_value_format(scan: Union[EndpointGenericScan, UrlGenericScan]):

    # To support old metrics:
    if "~" in scan.rating:
        return internet_nl_api_v1_requirement_tilde_value_format(scan)
    Severity: Minor
    Found in websecmap/reporting/severity.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 standard_calculation_for_internet_nl has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def standard_calculation_for_internet_nl(
    Severity: Major
    Found in websecmap/reporting/severity.py - About 1 hr to fix

      Function standard_calculation has 8 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def standard_calculation(
      Severity: Major
      Found in websecmap/reporting/severity.py - About 1 hr to fix

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

        def get_severity(scan: Union[EndpointGenericScan, UrlGenericScan]) -> Dict[str, Any]:
    # Can be probably more efficient by adding some methods to scan.
    if not calculation_methods.get(scan.type, None):
        raise ValueError("No calculation available for this scan type: %s" % scan.type)
        Severity: Minor
        Found in websecmap/reporting/severity.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 standard_calculation(scan=scan, explanation=f"{scan.rating} {scan.evidence}", high=1, medium=0, low=0)
        Severity: Major
        Found in websecmap/reporting/severity.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return standard_calculation(scan=scan, explanation=explanation, not_applicable=True)
          Severity: Major
          Found in websecmap/reporting/severity.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return standard_calculation_for_internet_nl(scan=scan, explanation=scan.explanation, not_applicable=True)
            Severity: Major
            Found in websecmap/reporting/severity.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return standard_calculation_for_internet_nl(scan=scan, explanation=scan.explanation, high=0, medium=0, low=1)
              Severity: Major
              Found in websecmap/reporting/severity.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                    return standard_calculation(scan, explanation, high, medium, low)
                Severity: Major
                Found in websecmap/reporting/severity.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                          return standard_calculation_for_internet_nl(scan=scan, explanation=scan.explanation, not_testable=True)
                  Severity: Major
                  Found in websecmap/reporting/severity.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return standard_calculation_for_internet_nl(scan=scan, explanation=scan.explanation, error_in_test=True)
                    Severity: Major
                    Found in websecmap/reporting/severity.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                              return standard_calculation_for_internet_nl(scan=scan, explanation=scan.explanation, not_applicable=True)
                      Severity: Major
                      Found in websecmap/reporting/severity.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                    return standard_calculation(scan=scan, explanation=explanation, high=0, medium=0, low=1)
                        Severity: Major
                        Found in websecmap/reporting/severity.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                  return standard_calculation(scan=scan, explanation=explanation, not_testable=True)
                          Severity: Major
                          Found in websecmap/reporting/severity.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                    return standard_calculation_for_internet_nl(scan=scan, explanation=scan.explanation, error_in_test=True)
                            Severity: Major
                            Found in websecmap/reporting/severity.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                      return standard_calculation(scan=scan, explanation=f"{scan.rating} {scan.evidence}", high=0, medium=1, low=0)
                              Severity: Major
                              Found in websecmap/reporting/severity.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                            return standard_calculation(scan=scan, explanation=explanation, high=0, medium=1, low=0)
                                Severity: Major
                                Found in websecmap/reporting/severity.py - About 30 mins to fix

                                  There are no issues that match your filters.

                                  Category
                                  Status