ValiMail/dane-discovery

View on GitHub

Showing 33 of 33 total issues

Function authenticate_tlsa has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def authenticate_tlsa(cls, dns_name, record, nsaddr=None, dns_timeout=5):
        """Return None if the identity is authenticated, or raise ValueError.

        This method authenticates a TLSA record as follows:

Severity: Minor
Found in dane_discovery/dane.py - About 55 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 verify_certificate_signature has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def verify_certificate_signature(cls, certificate, ca_certificate):
        """Return True if certificate was signed by ca_certificate.

        Args:
            entity_certificate (str): entity certificate in DER or PEM format.
Severity: Minor
Found in dane_discovery/pki.py - About 55 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

        try:
            # First, we try to parse as x509
            der = cls.certificate_association_to_der(certificate)
            cls.build_x509_object(der)
            return
Severity: Minor
Found in dane_discovery/pki.py and 1 other location - About 50 mins to fix
dane_discovery/pki.py on lines 249..254

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

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:
            # Next, we try as raw public key
            der = cls.certificate_association_to_der(certificate)
            cls.build_public_key_object_from_der(der)
            return
Severity: Minor
Found in dane_discovery/pki.py and 1 other location - About 50 mins to fix
dane_discovery/pki.py on lines 242..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 36.

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

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

    def validate_tlsa_fields(cls, tlsa_fields):
        """Validate the fields that come from DNS.

        Args:
            tlsa_fields (dict): Must contain the following keys:
Severity: Minor
Found in dane_discovery/dane.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 get_ca_certificates_for_identity has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def get_ca_certificates_for_identity(cls, identity_name, certificate, max_levels=100, nsaddr=None, dns_timeout=5):
Severity: Minor
Found in dane_discovery/dane.py - About 35 mins to fix

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

        def get_tlsa_records(cls, dnsname, nsaddr=None, dns_timeout=5):
            """TLSA records in a list of dictionaries.
    
            This method retrieves and parses the TLSA records from
            DNS for a given DNS name.
    Severity: Minor
    Found in dane_discovery/dane.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

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

    def main():
        """Wrap functionality provided by Identity.get_all_certificates()"""
        # Parse args
        args = parser.parse_args()
        # Get PKIX-CD certs from DNS
    Severity: Minor
    Found in dane_discovery/scripts/dane_discovery_get_ca_certificates.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 True, "Format and authority CA signature verified."
    Severity: Major
    Found in dane_discovery/identity.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return (False, msg)
      Severity: Major
      Found in dane_discovery/pki.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                return {x509_ext.oid._name: x509_ext.value}
        Severity: Major
        Found in dane_discovery/pki.py - About 30 mins to fix

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

              def validate_pkix_cd(self, cert_obj, credential):
                  """Validate a certificate with certificate_usage 4.
                  
                  PKIX-CD expects selector 0 and matching type 0. This
                  method will not validate configuration which differs 
          Severity: Minor
          Found in dane_discovery/identity.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 clean_up_certificate has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              def clean_up_certificate(cls, certificate):
                  """This method returns a clean PEM-encoded certificate.
                  
                  This is useful for removing the human-readable certificate
                  metadata that sometimes ends up in certificates produced 
          Severity: Minor
          Found in dane_discovery/pki.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

          Severity
          Category
          Status
          Source
          Language