haraka/haraka-plugin-dkim

View on GitHub
lib/dkim.js

Summary

Maintainability
F
1 wk
Test Coverage

Function handle_buf has a Cognitive Complexity of 82 (exceeds 5 allowed). Consider refactoring.
Open

  handle_buf(buf) {
    const self = this
    // Abort any further processing if the headers
    // did not contain any DKIM-Signature fields.
    if (this._in_body && this._no_signatures_found) {
Severity: Minor
Found in lib/dkim.js - About 1 day 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

File dkim.js has 635 lines of code (exceeds 250 allowed). Consider refactoring.
Open

'use strict'

const crypto = require('crypto')
const dns = require('dns')
const { Stream } = require('stream')
Severity: Major
Found in lib/dkim.js - About 1 day to fix

    Function constructor has a Cognitive Complexity of 51 (exceeds 5 allowed). Consider refactoring.
    Open

      constructor(header, header_idx, cb, opts) {
        this.cb = cb
        this.sig = header
        this.sig_md5 = md5(header)
        this.run_cb = false
    Severity: Minor
    Found in lib/dkim.js - About 7 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

    Function end has 142 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      end() {
        if (this.run_cb) return
    
        const bh = this.bh.digest('base64')
        this.debug(`${this.identity}: bodyhash=${this.fields.bh} computed=${bh}`)
    Severity: Major
    Found in lib/dkim.js - About 5 hrs to fix

      Function handle_buf has 122 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        handle_buf(buf) {
          const self = this
          // Abort any further processing if the headers
          // did not contain any DKIM-Signature fields.
          if (this._in_body && this._no_signatures_found) {
      Severity: Major
      Found in lib/dkim.js - About 4 hrs to fix

        Function constructor has 119 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          constructor(header, header_idx, cb, opts) {
            this.cb = cb
            this.sig = header
            this.sig_md5 = md5(header)
            this.run_cb = false
        Severity: Major
        Found in lib/dkim.js - About 4 hrs to fix

          Function end has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
          Open

            end() {
              if (this.run_cb) return
          
              const bh = this.bh.digest('base64')
              this.debug(`${this.identity}: bodyhash=${this.fields.bh} computed=${bh}`)
          Severity: Minor
          Found in lib/dkim.js - About 3 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

          Function write has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
          Open

            write(buf) {
              /*
               ** BODY (simple canonicalization)
               */
          
          
          Severity: Minor
          Found in lib/dkim.js - About 2 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

          Function canonicalize has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
          Open

            static canonicalize(bufin) {
              const tmp = []
              const len = bufin.length
              let last_chunk_idx = 0
              let idx_wsp = 0
          Severity: Minor
          Found in lib/dkim.js - 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 write has 35 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            write(buf) {
              /*
               ** BODY (simple canonicalization)
               */
          
          
          Severity: Minor
          Found in lib/dkim.js - About 1 hr to fix

            Function end has 33 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              end(buf) {
                this.writable = false
            
                // Add trailing CRLF if we have data left over
                if (this.buffer.ar.length) {
            Severity: Minor
            Found in lib/dkim.js - About 1 hr to fix

              Function callback has 32 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  function callback(err, result) {
                    self.pending--
                    if (result) {
                      const results = {
                        identity: result.identity,
              Severity: Minor
              Found in lib/dkim.js - About 1 hr to fix

                Function canonicalize has 28 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                  static canonicalize(bufin) {
                    const tmp = []
                    const len = bufin.length
                    let last_chunk_idx = 0
                    let idx_wsp = 0
                Severity: Minor
                Found in lib/dkim.js - About 1 hr to fix

                  Avoid deeply nested control flow statements.
                  Open

                              if (!match) continue
                  Severity: Major
                  Found in lib/dkim.js - About 45 mins to fix

                    Avoid deeply nested control flow statements.
                    Open

                                if (!this.header_idx[hn]) this.header_idx[hn] = []
                    Severity: Major
                    Found in lib/dkim.js - About 45 mins to fix

                      Avoid deeply nested control flow statements.
                      Open

                                  if (this.pending === 0) {
                                    process.nextTick(() => {
                                      if (self.cb) self.cb(new Error('no signatures found'))
                                    })
                                  }
                      Severity: Major
                      Found in lib/dkim.js - About 45 mins to fix

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

                          add_body_line(line) {
                            if (this.run_cb) return
                        
                            if (this.bodycanon === 'relaxed') {
                              line = DKIMObject.canonicalize(line)
                        Severity: Minor
                        Found in lib/dkim.js - 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

                        Avoid deeply nested control flow statements.
                        Open

                                    for (const dkimHeader of dkim_headers) {
                                      this.dkim_objects.push(
                                        new DKIMObject(
                                          dkimHeader,
                                          this.header_idx,
                        Severity: Major
                        Found in lib/dkim.js - About 45 mins to fix

                          Avoid deeply nested control flow statements.
                          Open

                                      if (h_md5 === this.sig_md5) {
                                        this.debug(`${this.identity}: skipped our own DKIM-Signature`)
                                        continue
                                      }
                          Severity: Major
                          Found in lib/dkim.js - About 45 mins to fix

                            Avoid deeply nested control flow statements.
                            Open

                                        if (!header_name) continue
                            Severity: Major
                            Found in lib/dkim.js - About 45 mins to fix

                              Avoid deeply nested control flow statements.
                              Open

                                            if (i.toLowerCase() !== this.fields.d.toLowerCase()) {
                                              return this.result(
                                                'i/d selector domain mismatch (t=s)',
                                                'invalid',
                                              )
                              Severity: Major
                              Found in lib/dkim.js - About 45 mins to fix

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

                                  end(buf) {
                                    this.writable = false
                                
                                    // Add trailing CRLF if we have data left over
                                    if (this.buffer.ar.length) {
                                Severity: Minor
                                Found in lib/dkim.js - 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 this.result('invalid expiration date', 'invalid')
                                Severity: Major
                                Found in lib/dkim.js - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                          return this.result(
                                            'creation date is invalid or in the future',
                                            'invalid',
                                          )
                                  Severity: Major
                                  Found in lib/dkim.js - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                        if (!this.fields.d) return this.result('domain missing', 'invalid')
                                    Severity: Major
                                    Found in lib/dkim.js - About 30 mins to fix

                                      Avoid too many return statements within this function.
                                      Open

                                            return this.result('signed headers missing', 'invalid')
                                      Severity: Major
                                      Found in lib/dkim.js - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                                return this.result('i/d selector domain mismatch', 'invalid')
                                        Severity: Major
                                        Found in lib/dkim.js - About 30 mins to fix

                                          Avoid too many return statements within this function.
                                          Open

                                                return this.result('missing algorithm', 'invalid')
                                          Severity: Major
                                          Found in lib/dkim.js - About 30 mins to fix

                                            Avoid too many return statements within this function.
                                            Open

                                                    return this.result(null, verified ? 'pass' : 'fail')
                                            Severity: Major
                                            Found in lib/dkim.js - About 30 mins to fix

                                              Avoid too many return statements within this function.
                                              Open

                                                    return this.result('unknown query method', 'invalid')
                                              Severity: Major
                                              Found in lib/dkim.js - About 30 mins to fix

                                                Avoid too many return statements within this function.
                                                Open

                                                              return this.result('inappropriate hash algorithm', 'invalid')
                                                Severity: Major
                                                Found in lib/dkim.js - About 30 mins to fix

                                                  Avoid too many return statements within this function.
                                                  Open

                                                            return this.result('inapplicable key', 'invalid')
                                                  Severity: Major
                                                  Found in lib/dkim.js - About 30 mins to fix

                                                    Avoid too many return statements within this function.
                                                    Open

                                                                    return this.result(
                                                                      'i/d selector domain mismatch (t=s)',
                                                                      'invalid',
                                                                    )
                                                    Severity: Major
                                                    Found in lib/dkim.js - About 30 mins to fix

                                                      Avoid too many return statements within this function.
                                                      Open

                                                              if (!this.dns_fields.p) return this.result('key revoked', 'invalid')
                                                      Severity: Major
                                                      Found in lib/dkim.js - About 30 mins to fix

                                                        Avoid too many return statements within this function.
                                                        Open

                                                                      return this.result('inapplicable key', 'invalid')
                                                        Severity: Major
                                                        Found in lib/dkim.js - About 30 mins to fix

                                                          Avoid too many return statements within this function.
                                                          Open

                                                                  return this.result(`signature expired`, 'invalid')
                                                          Severity: Major
                                                          Found in lib/dkim.js - About 30 mins to fix

                                                            Avoid too many return statements within this function.
                                                            Open

                                                                if (!this.fields.bh) return this.result('body hash missing', 'invalid')
                                                            Severity: Major
                                                            Found in lib/dkim.js - About 30 mins to fix

                                                              Avoid too many return statements within this function.
                                                              Open

                                                                      return this.result('from field not signed', 'invalid')
                                                              Severity: Major
                                                              Found in lib/dkim.js - About 30 mins to fix

                                                                Avoid too many return statements within this function.
                                                                Open

                                                                          return this.result('verification error', 'invalid')
                                                                Severity: Major
                                                                Found in lib/dkim.js - About 30 mins to fix

                                                                  Avoid too many return statements within this function.
                                                                  Open

                                                                            return this.result('invalid algorithm', 'invalid')
                                                                  Severity: Major
                                                                  Found in lib/dkim.js - About 30 mins to fix

                                                                    Avoid too many return statements within this function.
                                                                    Open

                                                                                return this.result('inappropriate key type', 'invalid')
                                                                    Severity: Major
                                                                    Found in lib/dkim.js - About 30 mins to fix

                                                                      Avoid too many return statements within this function.
                                                                      Open

                                                                          if (!this.fields.b) return this.result('signature missing', 'invalid')
                                                                      Severity: Major
                                                                      Found in lib/dkim.js - About 30 mins to fix

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

                                                                              if (dom.toLowerCase() !== this.fields.d.toLowerCase()) {
                                                                                return this.result('i/d selector domain mismatch', 'invalid')
                                                                              }
                                                                        Severity: Minor
                                                                        Found in lib/dkim.js and 1 other location - About 30 mins to fix
                                                                        lib/dkim.js on lines 373..378

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

                                                                        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 (i.toLowerCase() !== this.fields.d.toLowerCase()) {
                                                                                        return this.result(
                                                                                          'i/d selector domain mismatch (t=s)',
                                                                                          'invalid',
                                                                                        )
                                                                        Severity: Minor
                                                                        Found in lib/dkim.js and 1 other location - About 30 mins to fix
                                                                        lib/dkim.js on lines 149..151

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

                                                                        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