Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrations Vault: handle Overwrite secret data on Set #4387

Merged
merged 2 commits into from
Jul 22, 2024
Merged

Integrations Vault: handle Overwrite secret data on Set #4387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c15ad5c
feat: aws secrets manager: handle Overwrite secret vault on Set
slntopp Jul 22, 2024
3ba3e4a
feat: berglas: use update and CreateIfMissing strategy for Set
slntopp Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions providers-sdk/v1/vault/awssecretsmanager/secretsmanager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ package awssecretsmanager

import (
"context"
"errors"

"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/secretsmanager"
"github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
"github.com/aws/aws-sdk-go/aws/arn"
"github.com/rs/zerolog/log"
"go.mondoo.com/cnquery/v11/providers-sdk/v1/vault"
Expand Down Expand Up @@ -88,6 +90,29 @@ func (v *Vault) Set(ctx context.Context, cred *vault.Secret) (*vault.SecretID, e
SecretBinary: cred.Data,
KmsKeyId: kmsKeyID,
})
if err != nil {
var aerr *types.ResourceExistsException
if errors.As(err, &aerr) {
return v.updateSecret(ctx, cred)
}

return nil, err
}

return &vault.SecretID{Key: *o.ARN}, err
}

func (v *Vault) updateSecret(ctx context.Context, cred *vault.Secret) (*vault.SecretID, error) {
var kmsKeyID *string
if len(v.kmsKeyID) > 0 {
kmsKeyID = &v.kmsKeyID
}

c := secretsmanager.NewFromConfig(v.cfg)
o, err := c.UpdateSecret(ctx, &secretsmanager.UpdateSecretInput{
SecretBinary: cred.Data,
KmsKeyId: kmsKeyID,
})
if err != nil {
return nil, err
}
Expand Down
24 changes: 24 additions & 0 deletions providers-sdk/v1/vault/awssecretsmanager/secretsmanager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,27 @@ func TestAwsSecretsManager(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, cred.Data, get.Data)
}

func TestAwsSecretsManagerOverwrite(t *testing.T) {
ctx := context.Background()
cfg, err := config.LoadDefaultConfig(ctx)
require.NoError(t, err)
v := New(cfg, WithKmsKey("alias/aws/secretsmanager"))

cred := &vault.Secret{
Data: []byte("my-secret-data"),
Key: "mik-test-secret-2",
}
s, err := v.Set(ctx, cred)
require.NoError(t, err)
get, err := v.Get(ctx, &vault.SecretID{Key: s.Key})
require.NoError(t, err)
assert.Equal(t, cred.Data, get.Data)

cred.Data = []byte("my-even-more-secret-data")
s, err = v.Set(ctx, cred)
require.NoError(t, err)
get, err = v.Get(ctx, &vault.SecretID{Key: s.Key})
require.NoError(t, err)
assert.Equal(t, cred.Data, get.Data)
}
11 changes: 6 additions & 5 deletions providers-sdk/v1/vault/gcpberglas/berglas.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,12 @@ func (v *Vault) Set(ctx context.Context, cred *vault.Secret) (*vault.SecretID, e
return nil, err
}

_, err = c.Create(ctx, &berglas.StorageCreateRequest{
Bucket: v.bucket,
Object: cred.Key,
Plaintext: cred.Data,
Key: v.kmsKeyID,
_, err = c.Update(ctx, &berglas.StorageUpdateRequest{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does that create if the key doesn't exist?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's what documentation suggests
if that's not what API is actually doing, we can rewrite it like aws secrets manager (create -> if AlreadyExists -> Update)

ref: https://pkg.go.dev/github.com/GoogleCloudPlatform/berglas@v1.0.3/pkg/berglas#StorageUpdateRequest

Bucket: v.bucket,
Object: cred.Key,
Plaintext: cred.Data,
Key: v.kmsKeyID,
CreateIfMissing: true,
})
if err != nil {
return nil, err
Expand Down
7 changes: 7 additions & 0 deletions providers-sdk/v1/vault/gcpberglas/berglas_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,11 @@ func TestGcpBerglas(t *testing.T) {
get, err := v.Get(ctx, &vault.SecretID{Key: cred.Key})
require.NoError(t, err)
assert.Equal(t, cred.Data, get.Data)

cred.Data = []byte("my-even-more-secret-data")
_, err = v.Set(ctx, cred)
require.NoError(t, err)
get, err = v.Get(ctx, &vault.SecretID{Key: cred.Key})
require.NoError(t, err)
assert.Equal(t, cred.Data, get.Data)
}
Loading