Skip to content

HVS: rotating secret support #893

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

Merged
merged 1 commit into from
Sep 3, 2024
Merged

HVS: rotating secret support #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions controllers/hcpvaultsecretsapp_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ func (r *HCPVaultSecretsAppReconciler) Reconcile(ctx context.Context, req ctrl.R
AppName: o.Spec.AppName,
Types: []string{
helpers.HVSSecretTypeKV,
helpers.HVSSecretTypeRotating,
},
}

Expand Down
20 changes: 15 additions & 5 deletions internal/helpers/secrets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ import (
)

const (
SecretDataKeyRaw = "_raw"
HVSSecretTypeKV = "kv"
SecretDataKeyRaw = "_raw"
HVSSecretTypeKV = "kv"
HVSSecretTypeRotating = "rotating"
)

var SecretDataErrorContainsRaw = fmt.Errorf("key '%s' not permitted in Secret data", SecretDataKeyRaw)
Expand Down Expand Up @@ -497,11 +498,21 @@ func (s *SecretDataBuilder) WithHVSAppSecrets(resp *hvsclient.OpenAppSecretsOK,
data := make(map[string][]byte)
hasTemplates := len(opt.KeyedTemplates) > 0
for _, v := range p.Secrets {
if v.StaticVersion == nil {
if v.StaticVersion == nil && v.RotatingVersion == nil {
continue
}

if v.Type != HVSSecretTypeKV {
switch v.Type {
case HVSSecretTypeKV:
secrets[v.Name] = v.StaticVersion.Value
case HVSSecretTypeRotating:
// Since rotating secrets have multiple values, prefix each key with
// the secret name to avoid collisions.
for rvk, rvv := range v.RotatingVersion.Values {
rName := fmt.Sprintf("%s_%s", v.Name, rvk)
secrets[rName] = rvv
}
default:
continue
}

Expand All @@ -515,7 +526,6 @@ func (s *SecretDataBuilder) WithHVSAppSecrets(resp *hvsclient.OpenAppSecretsOK,
// maps secret name to its secret metadata
metadata[v.Name] = m
}
secrets[v.Name] = v.StaticVersion.Value
}

if hasTemplates {
Expand Down
76 changes: 63 additions & 13 deletions internal/helpers/secrets_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1304,6 +1304,29 @@ func TestSecretDataBuilder_WithHVSAppSecrets(t *testing.T) {
},
Type: HVSSecretTypeKV,
},
{
CreatedAt: strfmt.NewDateTime(),
CreatedByID: "vso-2 uuid",
LatestVersion: 1,
Name: "rotatingfoo",
Provider: "providerfoo",
SyncStatus: nil,
RotatingVersion: &models.Secrets20231128OpenSecretRotatingVersion{
CreatedAt: strfmt.DateTime{},
CreatedByID: "vault-secrets-rotator",
ExpiresAt: strfmt.DateTime{},
Keys: []string{
"api_key_one",
"api_key_two",
},
Values: map[string]string{
"api_key_one": "123456",
"api_key_two": "654321",
},
Version: 1,
},
Type: HVSSecretTypeRotating,
},
},
},
}
Expand Down Expand Up @@ -1366,9 +1389,11 @@ func TestSecretDataBuilder_WithHVSAppSecrets(t *testing.T) {
name: "valid",
resp: respValid,
want: map[string][]byte{
"bar": []byte("foo"),
"foo": []byte("qux"),
SecretDataKeyRaw: rawValid,
"bar": []byte("foo"),
"foo": []byte("qux"),
"rotatingfoo_api_key_one": []byte("123456"),
"rotatingfoo_api_key_two": []byte("654321"),
SecretDataKeyRaw: rawValid,
},
wantErr: assert.NoError,
},
Expand All @@ -1387,9 +1412,11 @@ func TestSecretDataBuilder_WithHVSAppSecrets(t *testing.T) {
},
},
want: map[string][]byte{
"bar": []byte("FOO"),
"foo": []byte("qux"),
SecretDataKeyRaw: rawValid,
"bar": []byte("FOO"),
"foo": []byte("qux"),
"rotatingfoo_api_key_one": []byte("123456"),
"rotatingfoo_api_key_two": []byte("654321"),
SecretDataKeyRaw: rawValid,
},
wantErr: assert.NoError,
},
Expand Down Expand Up @@ -1428,12 +1455,31 @@ func TestSecretDataBuilder_WithHVSAppSecrets(t *testing.T) {
"version": 2
},
"type": "kv"
},
"rotatingfoo": {
"created_at": "1970-01-01T00:00:00.000Z",
"latest_version": 1,
"name": "rotatingfoo",
"provider": "providerfoo",
"rotating_version": {
"created_at": "0001-01-01T00:00:00.000Z",
"expires_at": "0001-01-01T00:00:00.000Z",
"keys": [
"api_key_one",
"api_key_two"
],
"revoked_at": "0001-01-01T00:00:00.000Z",
"version": 1
},
"type": "rotating"
}
}`,
),
"bar": []byte("foo"),
"foo": []byte("qux"),
SecretDataKeyRaw: rawValid,
"bar": []byte("foo"),
"foo": []byte("qux"),
"rotatingfoo_api_key_one": []byte("123456"),
"rotatingfoo_api_key_two": []byte("654321"),
SecretDataKeyRaw: rawValid,
},
wantErr: assert.NoError,
},
Expand Down Expand Up @@ -1465,8 +1511,10 @@ func TestSecretDataBuilder_WithHVSAppSecrets(t *testing.T) {
Includes: []string{"foo"},
},
want: map[string][]byte{
"foo": []byte("qux"),
SecretDataKeyRaw: rawValid,
"foo": []byte("qux"),
"rotatingfoo_api_key_one": []byte("123456"),
"rotatingfoo_api_key_two": []byte("654321"),
SecretDataKeyRaw: rawValid,
},
wantErr: assert.NoError,
},
Expand Down Expand Up @@ -1517,8 +1565,10 @@ func TestSecretDataBuilder_WithHVSAppSecrets(t *testing.T) {
ExcludeRaw: true,
},
want: map[string][]byte{
"bar": []byte("foo"),
"foo": []byte("qux"),
"bar": []byte("foo"),
"foo": []byte("qux"),
"rotatingfoo_api_key_one": []byte("123456"),
"rotatingfoo_api_key_two": []byte("654321"),
},
wantErr: assert.NoError,
},
Expand Down