SpamExperts/OrangeAssassin

View on GitHub
oa/plugins/relay_eval.py

Summary

Maintainability
D
2 days
Test Coverage

Cyclomatic complexity is too high in method _check_for_forged_received. (21)
Open

    def _check_for_forged_received(self, msg):
        mismatch_from = 0
        mismatch_ip_helo = 0
        hostname_re = Regex(r"^\w+(?:[\w.-]+\.)+\w+$")
        ip_re = Regex(r"^(\d+\.\d+)\.\d+\.\d+")
Severity: Minor
Found in oa/plugins/relay_eval.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 _check_for_forged_received has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

    def _check_for_forged_received(self, msg):
        mismatch_from = 0
        mismatch_ip_helo = 0
        hostname_re = Regex(r"^\w+(?:[\w.-]+\.)+\w+$")
        ip_re = Regex(r"^(\d+\.\d+)\.\d+\.\d+")
Severity: Minor
Found in oa/plugins/relay_eval.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

Cyclomatic complexity is too high in method check_for_from_domain_in_received_headers. (7)
Open

    def check_for_from_domain_in_received_headers(self, msg, domain, desired,
                                                  option=None, target=None):
        """Verify if the sender address inside From: header appears in relays
        Parameters:
            - domain: the domain to search for
Severity: Minor
Found in oa/plugins/relay_eval.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 method helo_ip_mismatch. (7)
Open

    def helo_ip_mismatch(self, msg, option=None, target=None):
        """Check untrusted relays and verify if helo and ip are different
        but have the same /24 netmask"""
        for relay in msg.untrusted_relays:
            if not self._check_helo(relay):
Severity: Minor
Found in oa/plugins/relay_eval.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 method check_for_no_rdns_dotcom_helo. (6)
Open

    def check_for_no_rdns_dotcom_helo(self, msg, option=None, target=None):
        """Check untrusted relays and verify if latest relay it has helo from
        a big email provider like lycos, hotmail, excite, caramail, cs, aol,
        msn, yahoo, drizzle"""
        no_rdns_dotcom_helo = False
Severity: Minor
Found in oa/plugins/relay_eval.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 check_for_no_rdns_dotcom_helo has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def check_for_no_rdns_dotcom_helo(self, msg, option=None, target=None):
        """Check untrusted relays and verify if latest relay it has helo from
        a big email provider like lycos, hotmail, excite, caramail, cs, aol,
        msn, yahoo, drizzle"""
        no_rdns_dotcom_helo = False
Severity: Minor
Found in oa/plugins/relay_eval.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 check_for_from_domain_in_received_headers has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def check_for_from_domain_in_received_headers(self, msg, domain, desired,
Severity: Minor
Found in oa/plugins/relay_eval.py - About 35 mins to fix

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

        def helo_ip_mismatch(self, msg, option=None, target=None):
            """Check untrusted relays and verify if helo and ip are different
            but have the same /24 netmask"""
            for relay in msg.untrusted_relays:
                if not self._check_helo(relay):
    Severity: Minor
    Found in oa/plugins/relay_eval.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

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

        def check_for_forged_received_trail(self, msg, option=None, target=None):
            """Check if there are more than one untrusted relays and verify if
            rdns is different than the other relay's by."""
            try:
                mismatch_from = self.get_global("mismatch_from")
    Severity: Major
    Found in oa/plugins/relay_eval.py and 1 other location - About 5 hrs to fix
    oa/plugins/relay_eval.py on lines 139..150

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

    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

        def check_for_forged_received_ip_helo(self, msg, option=None, target=None):
            """Verify if helo and ip are IP ADDRESSES and if they are different,
            this means that received ip is forged"""
            try:
                mismatch_ip_helo = self.get_global("mismatch_ip_helo")
    Severity: Major
    Found in oa/plugins/relay_eval.py and 1 other location - About 5 hrs to fix
    oa/plugins/relay_eval.py on lines 126..137

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

    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

    Line too long (81 > 79 characters)
    Open

                                "rule no longer available, please update your rules")
    Severity: Minor
    Found in oa/plugins/relay_eval.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
    lines; plus, limiting windows to 80 characters makes it possible to
    have several windows side-by-side.  The default wrapping on such
    devices looks ugly.  Therefore, please limit all lines to a maximum
    of 79 characters. For flowing long blocks of text (docstrings or
    comments), limiting the length to 72 characters is recommended.
    
    Reports error E501.

    Line too long (80 > 79 characters)
    Open

            self.ctxt.log.debug("RelayEval::Plugin the 'check_for_illegal_ip' eval "
    Severity: Minor
    Found in oa/plugins/relay_eval.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
    lines; plus, limiting windows to 80 characters makes it possible to
    have several windows side-by-side.  The default wrapping on such
    devices looks ugly.  Therefore, please limit all lines to a maximum
    of 79 characters. For flowing long blocks of text (docstrings or
    comments), limiting the length to 72 characters is recommended.
    
    Reports error E501.

    Line too long (81 > 79 characters)
    Open

                if helo != ip and netmask_24_ip and netmask_24_helo != netmask_24_ip:
    Severity: Minor
    Found in oa/plugins/relay_eval.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
    lines; plus, limiting windows to 80 characters makes it possible to
    have several windows side-by-side.  The default wrapping on such
    devices looks ugly.  Therefore, please limit all lines to a maximum
    of 79 characters. For flowing long blocks of text (docstrings or
    comments), limiting the length to 72 characters is recommended.
    
    Reports error E501.

    Over-indented
    Open

                        from_host = "undef"
    Severity: Minor
    Found in oa/plugins/relay_eval.py by pep8

    Use indent_size (PEP8 says 4) spaces per indentation level.

    For really old code that you don't want to mess up, you can continue
    to use 8-space tabs.
    
    Okay: a = 1
    Okay: if a == 0:\n    a = 1
    E111:   a = 1
    E114:   # a = 1
    
    Okay: for item in items:\n    pass
    E112: for item in items:\npass
    E115: for item in items:\n# Hi\n    pass
    
    Okay: a = 1\nb = 2
    E113: a = 1\n    b = 2
    E116: a = 1\n    # b = 2

    There are no issues that match your filters.

    Category
    Status