tlsfuzzer/tlslite-ng

View on GitHub
tlslite/handshakesettings.py

Summary

Maintainability
D
2 days
Test Coverage
A
98%

File handshakesettings.py has 670 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# Authors:
#   Trevor Perrin
#   Dave Baggett (Arcode Corporation) - cleanup handling of constants
#   Yngve Pettersen (ported by Paul Sokolovsky) - TLS 1.2
#
Severity: Major
Found in tlslite/handshakesettings.py - About 1 day to fix

    HandshakeSettings has 23 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class HandshakeSettings(object):
        """
        This class encapsulates various parameters that can be used with
        a TLS handshake.
    
    
    Severity: Minor
    Found in tlslite/handshakesettings.py - About 2 hrs to fix

      Cyclomatic complexity is too high in method _sanityCheckExtensions. (14)
      Open

          @staticmethod
          def _sanityCheckExtensions(other):
              """Check if set extension settings are sane"""
              not_matching = HandshakeSettings._not_matching
      
      
      Severity: Minor
      Found in tlslite/handshakesettings.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 _sanityCheckECDHSettings. (12)
      Open

          @staticmethod
          def _sanityCheckECDHSettings(other):
              """Check ECDHE settings if they are sane."""
              not_matching = HandshakeSettings._not_matching
      
      
      Severity: Minor
      Found in tlslite/handshakesettings.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 _sanityCheckExtensions has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          def _sanityCheckExtensions(other):
              """Check if set extension settings are sane"""
              not_matching = HandshakeSettings._not_matching
      
              if other.useEncryptThenMAC not in (True, False):
      Severity: Minor
      Found in tlslite/handshakesettings.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 _sanityCheckECDHSettings has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def _sanityCheckECDHSettings(other):
              """Check ECDHE settings if they are sane."""
              not_matching = HandshakeSettings._not_matching
      
              unknownCurve = not_matching(other.eccCurves, ALL_CURVE_NAMES)
      Severity: Minor
      Found in tlslite/handshakesettings.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 _sanityCheckKeySizes has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def _sanityCheckKeySizes(other):
              """Check if key size limits are sane"""
              if other.minKeySize < 512:
                  raise ValueError("minKeySize too small")
              if other.minKeySize > 16384:
      Severity: Minor
      Found in tlslite/handshakesettings.py - About 25 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 _sanityCheckPrimitivesNames has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def _sanityCheckPrimitivesNames(other):
              """Check if specified cryptographic primitive names are known"""
              HandshakeSettings._sanityCheckCipherSettings(other)
              HandshakeSettings._sanityCheckDHSettings(other)
      
      
      Severity: Minor
      Found in tlslite/handshakesettings.py - About 25 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

      TODO found
      Open

          TODO: add the above
      Severity: Minor
      Found in tlslite/handshakesettings.py by fixme

      TODO found
      Open

          TODO: support SRP as alternative to certificates
      Severity: Minor
      Found in tlslite/handshakesettings.py by fixme

      TODO found
      Open

          TODO: support PSK as alternative to certificates
      Severity: Minor
      Found in tlslite/handshakesettings.py by fixme

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

              if other.certificate_compression_send:
                  try:
                      unknownAlgos = not_matching(
                          other.certificate_compression_send,
                          ALL_COMPRESSION_ALGOS_SEND)
      Severity: Major
      Found in tlslite/handshakesettings.py and 1 other location - About 1 hr to fix
      tlslite/handshakesettings.py on lines 660..670

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

      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 other.certificate_compression_receive:
                  try:
                      unknownAlgos = not_matching(
                          other.certificate_compression_receive,
                          ALL_COMPRESSION_ALGOS_RECEIVE)
      Severity: Major
      Found in tlslite/handshakesettings.py and 1 other location - About 1 hr to fix
      tlslite/handshakesettings.py on lines 647..657

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

      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 (83 > 79 characters)
      Open

              if other.heartbeat_response_callback and not other.use_heartbeat_extension:
      Severity: Minor
      Found in tlslite/handshakesettings.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 (93 > 79 characters)
      Open

                      raise ValueError("The following enabled groups are forbidden in TLS 1.3: {0}"
      Severity: Minor
      Found in tlslite/handshakesettings.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 (101 > 79 characters)
      Open

                  forbiddenGroup = HandshakeSettings._not_matching(other.eccCurves, TLS13_PERMITTED_GROUPS)
      Severity: Minor
      Found in tlslite/handshakesettings.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

          :ivar ~.record_size_limit: maximum size of records we are willing to process
      Severity: Minor
      Found in tlslite/handshakesettings.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 (98 > 79 characters)
      Open

      # list of supported groups in TLS 1.3 as per RFC 8446, chapter 4.2.7. (excluding private use here)
      Severity: Minor
      Found in tlslite/handshakesettings.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.

      The backslash is redundant between brackets
      Open

                  raise ValueError("Unknown ECDSA signature hash: '{0}'".\
      Severity: Minor
      Found in tlslite/handshakesettings.py by pep8

      Avoid explicit line join between brackets.

      The preferred way of wrapping long lines is by using Python's
      implied line continuation inside parentheses, brackets and braces.
      Long lines can be broken over multiple lines by wrapping expressions
      in parentheses.  These should be used in preference to using a
      backslash for line continuation.
      
      E502: aaa = [123, \\n       123]
      E502: aaa = ("bbb " \\n       "ccc")
      
      Okay: aaa = [123,\n       123]
      Okay: aaa = ("bbb "\n       "ccc")
      Okay: aaa = "bbb " \\n    "ccc"
      Okay: aaa = 123  # \\

      There are no issues that match your filters.

      Category
      Status