Sign upLogin

saltstack/salt

View on GitHub
Star
salt/transport/mixins/auth.py

Summary

Maintainability
F
1 wk
Test Coverage

Function _auth has a Cognitive Complexity of 120 (exceeds 5 allowed). Consider refactoring.
Open

    def _auth(self, load):
        '''
        Authenticate the client, use the sent public key to encrypt the AES key
        which was generated at start up.
Severity: Minor
Found in salt/transport/mixins/auth.py - About 2 days 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 _auth. (65)
Open

    def _auth(self, load):
        '''
        Authenticate the client, use the sent public key to encrypt the AES key
        which was generated at start up.
Severity: Minor
Found in salt/transport/mixins/auth.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

File auth.py has 404 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-

# Import Python Libs
from __future__ import absolute_import, print_function, unicode_literals
import multiprocessing
Severity: Minor
Found in salt/transport/mixins/auth.py - About 5 hrs to fix

    Avoid deeply nested control flow statements.
    Open

                            if self.opts.get('auth_events') is True:
                            self.event.fire_event(eload, salt.utils.event.tagify(prefix='auth'))
                        return {'enc': 'clear',
    Severity: Major
    Found in salt/transport/mixins/auth.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                              if self.opts.get('auth_events') is True:
                            self.event.fire_event(eload, salt.utils.event.tagify(prefix='auth'))
                        return {'enc': 'clear',
      Severity: Major
      Found in salt/transport/mixins/auth.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                with salt.utils.files.fopen(pubfn_denied, 'w+') as fp_:
                            fp_.write(load['pub'])
                        eload = {'result': False,
        Severity: Major
        Found in salt/transport/mixins/auth.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                                  with salt.utils.files.fopen(pubfn_denied, 'w+') as fp_:
                            fp_.write(load['pub'])
                        eload = {'result': False,
          Severity: Major
          Found in salt/transport/mixins/auth.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                    if self.opts.get('auth_events') is True:
                            self.event.fire_event(eload, salt.utils.event.tagify(prefix='auth'))
                        return {'enc': 'clear',
            Severity: Major
            Found in salt/transport/mixins/auth.py - About 45 mins to fix

              Avoid too many return statements within this function.
              Open

                              return {'enc': 'clear',
              Severity: Major
              Found in salt/transport/mixins/auth.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                return ret
                Severity: Major
                Found in salt/transport/mixins/auth.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                          return {'enc': 'clear',
                  Severity: Major
                  Found in salt/transport/mixins/auth.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return ret
                    Severity: Major
                    Found in salt/transport/mixins/auth.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                      return ret
                      Severity: Major
                      Found in salt/transport/mixins/auth.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                                return {'enc': 'clear',
                        Severity: Major
                        Found in salt/transport/mixins/auth.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                      return {'enc': 'clear',
                          Severity: Major
                          Found in salt/transport/mixins/auth.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                            return {'enc': 'clear',
                            Severity: Major
                            Found in salt/transport/mixins/auth.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                          return {'enc': 'clear',
                              Severity: Major
                              Found in salt/transport/mixins/auth.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                                        return {'enc': 'clear',
                                Severity: Major
                                Found in salt/transport/mixins/auth.py - About 30 mins to fix

                                  Function _encrypt_private has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                  Open

                                      def _encrypt_private(self, ret, dictkey, target):
        '''
        The server equivalent of ReqChannel.crypted_transfer_decode_dictentry
        '''
        # encrypt with a specific AES key
                                  Severity: Minor
                                  Found in salt/transport/mixins/auth.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 _decode_payload has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                  Open

                                      def _decode_payload(self, payload):
        # we need to decrypt it
        if payload['enc'] == 'aes':
            try:
                payload['load'] = self.crypticle.loads(payload['load'])
                                  Severity: Minor
                                  Found in salt/transport/mixins/auth.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

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

                                                  if pubfn_handle.read().strip() != load['pub'].strip():
                    log.error(
                        'Authentication attempt from %s failed, the public '
                        'keys did not match. This may be an attempt to compromise '
                        'the Salt cluster.', load['id']
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 1 day to fix
                                  salt/transport/mixins/auth.py on lines 340..356

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

                                  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 pubfn_handle.read() != load['pub']:
                        log.error(
                            'Authentication attempt from %s failed, the public '
                            'key in pending did not match. This may be an '
                            'attempt to compromise the Salt cluster.', load['id']
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 1 day to fix
                                  salt/transport/mixins/auth.py on lines 252..268

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

                                  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 os.path.isdir(pubfn_pend):
                # The key path is a directory, error out
                log.info('New public key %s is a directory', load['id'])
                eload = {'result': False,
                         'id': load['id'],
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 5 hrs to fix
                                  salt/transport/mixins/auth.py on lines 237..247

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

                                  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

                                          elif os.path.isfile(pubfn_rejected):
            # The key has been rejected, don't place it in pending
            log.info('Public key rejected for %s. Key is present in '
                     'rejection key dir.', load['id'])
            eload = {'result': False,
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 5 hrs to fix
                                  salt/transport/mixins/auth.py on lines 272..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 97.

                                  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 HAS_M2:
                ret['aes'] = pub.public_encrypt(aes, RSA.pkcs1_oaep_padding)
            else:
                ret['aes'] = cipher.encrypt(aes)
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 1 hr to fix
                                  salt/transport/mixins/auth.py on lines 506..510

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

                                  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 HAS_M2:
                ret['aes'] = pub.public_encrypt(aes,
                                                RSA.pkcs1_oaep_padding)
            else:
                ret['aes'] = cipher.encrypt(aes)
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 1 hr to fix
                                  salt/transport/mixins/auth.py on lines 486..489

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

                                  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

                                              salt.master.SMaster.secrets['aes'] = {
                'secret': multiprocessing.Array(
                    ctypes.c_char,
                    salt.utils.stringutils.to_bytes(salt.crypt.Crypticle.generate_key_string())
                ),
                                  Severity: Major
                                  Found in salt/transport/mixins/auth.py and 1 other location - About 1 hr to fix
                                  salt/master.py on lines 665..672

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

                                  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