Sign upLogin

ecadlabs/signatory

View on GitHub
Star
pkg/vault/cloudkms/cloudkms.go

Summary

Maintainability
C
1 day
Test Coverage
F
36%

Method cloudKMSIterator.Next has a Cognitive Complexity of 37 (exceeds 20 allowed). Consider refactoring.
Open

func (c *cloudKMSIterator) Next() (vault.StoredKey, error) {
    if c.keyIter == nil {
        return nil, vault.ErrDone
    }
Severity: Minor
Found in pkg/vault/cloudkms/cloudkms.go - 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

Method Vault.Import has 90 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func (c *Vault) Import(ctx context.Context, pk crypt.PrivateKey, opt utils.Options) (vault.StoredKey, error) {
    keyName, ok, err := opt.GetString("name")
    if err != nil {
        return nil, fmt.Errorf("(CloudKMS/%s): %w", c.config.keyRingName(), err)
    }
Severity: Major
Found in pkg/vault/cloudkms/cloudkms.go - About 2 hrs to fix

    Method Vault.Import has 14 return statements (exceeds 4 allowed).
    Open

    func (c *Vault) Import(ctx context.Context, pk crypt.PrivateKey, opt utils.Options) (vault.StoredKey, error) {
    keyName, ok, err := opt.GetString("name")
    if err != nil {
        return nil, fmt.Errorf("(CloudKMS/%s): %w", c.config.keyRingName(), err)
    }
    Severity: Major
    Found in pkg/vault/cloudkms/cloudkms.go - About 1 hr to fix

      Avoid deeply nested control flow statements.
      Open

                          if err == iterator.Done {
                        c.keyIter = nil
                        return nil, vault.ErrDone
                    } else {
                        return nil, fmt.Errorf("(CloudKMS/%s) ListCryptoKeys: %w", c.vault.config.keyRingName(), err)
      Severity: Major
      Found in pkg/vault/cloudkms/cloudkms.go - About 45 mins to fix

        Method cloudKMSIterator.Next has 6 return statements (exceeds 4 allowed).
        Open

        func (c *cloudKMSIterator) Next() (vault.StoredKey, error) {
    if c.keyIter == nil {
        return nil, vault.ErrDone
    }
        Severity: Major
        Found in pkg/vault/cloudkms/cloudkms.go - About 40 mins to fix

          Function wrapPrivateKey has 6 return statements (exceeds 4 allowed).
          Open

          func wrapPrivateKey(pubKey *rsa.PublicKey, priv crypt.PrivateKey) ([]byte, error) {
    pkcs8Key, err := cryptoutils.MarshalPKCS8PrivateKey(priv)
    if err != nil {
        return nil, err
    }
          Severity: Major
          Found in pkg/vault/cloudkms/cloudkms.go - About 40 mins to fix

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

            func init() {
    vault.RegisterVault("cloudkms", func(ctx context.Context, node *yaml.Node) (vault.Vault, error) {
        var conf Config
        if node == nil || node.Kind == 0 {
            return nil, errors.New("(CloudKMS): config is missing")
            Severity: Major
            Found in pkg/vault/cloudkms/cloudkms.go and 4 other locations - About 1 hr to fix
            pkg/vault/aws/awskms.go on lines 172..188
            pkg/vault/hashicorp/vault.go on lines 60..76
            pkg/vault/yubi/yubi.go on lines 421..437
            pkg/vault/azure/azure.go on lines 466..482

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

            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