Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .changelog/1644.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
`helm_release`: Fix shallow clone bug causing nested sensitive values to be redacted in the k8s API
```
3 changes: 2 additions & 1 deletion helm/data_helm_template_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ func TestAccDataTemplate_basic(t *testing.T) {
Steps: []resource.TestStep{{
Config: testAccDataHelmTemplateConfigBasic(testResourceName, namespace, name, "1.2.3"),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr(datasourceAddress, "manifests.%", "5"),
resource.TestCheckResourceAttr(datasourceAddress, "manifests.%", "6"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/deployment.yaml"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/service.yaml"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/serviceaccount.yaml"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/configmaps.yaml"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/secrets.yaml"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/tests/test-connection.yaml"),
resource.TestCheckResourceAttrSet(datasourceAddress, "manifest"),
resource.TestCheckResourceAttrSet(datasourceAddress, "notes"),
Expand Down
29 changes: 24 additions & 5 deletions helm/resource_helm_release.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"context"
"encoding/json"
"fmt"
"maps"
"net/url"
"os"
pathpkg "path"
Expand Down Expand Up @@ -1424,10 +1423,28 @@ func getValue(base map[string]interface{}, set setResourceModel) diag.Diagnostic
return diags
}

// deepCloneMap creates a deep copy of a map[string]interface{}
func deepCloneMap(m map[string]interface{}) map[string]interface{} {
if m == nil {
return nil
}

clone := make(map[string]interface{}, len(m))
for k, v := range m {
switch val := v.(type) {
case map[string]interface{}:
clone[k] = deepCloneMap(val)
default:
clone[k] = v
}
}
return clone
}

func logValues(ctx context.Context, values map[string]interface{}, state *HelmReleaseModel) diag.Diagnostics {
var diags diag.Diagnostics
// Cloning values map
c := maps.Clone(values)
// Deep cloning values map to avoid modifying the original
c := deepCloneMap(values)

cloakSetValues(c, state)

Expand Down Expand Up @@ -1519,10 +1536,12 @@ func setReleaseAttributes(ctx context.Context, state *HelmReleaseModel, identity
}

// Cloak sensitive values in the release config
cloakSetValues(r.Config, state)
values := "{}"
if r.Config != nil {
v, err := json.Marshal(r.Config)
// Deep clone the config to avoid modifying the original
configClone := deepCloneMap(r.Config)
cloakSetValues(configClone, state)
v, err := json.Marshal(configClone)
if err != nil {
diags.AddError(
"Error marshaling values",
Expand Down
37 changes: 30 additions & 7 deletions helm/resource_helm_release_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"helm.sh/helm/v3/pkg/releaseutil"
"helm.sh/helm/v3/pkg/repo"

v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
)
Expand Down Expand Up @@ -386,20 +387,41 @@ func TestAccResourceRelease_cloakValues(t *testing.T) {
namespace := createRandomNamespace(t)
defer deleteNamespace(t, namespace)

secretKey := "cloakedData.cloaked"
secretValue := "foobar"

resource.Test(t, resource.TestCase{
// PreCheck: func() { testAccPreCheck(t) },
ProtoV6ProviderFactories: protoV6ProviderFactories(),
// CheckDestroy: testAccCheckHelmReleaseDestroy(namespace),
Steps: []resource.TestStep{
{
Config: testAccHelmReleaseConfigSensitiveValue(
testResourceName, namespace, name, "test-chart", "1.2.3", "foo", "bar",
testResourceName, namespace, name, "test-chart", "1.2.3", secretKey, secretValue,
),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr("helm_release.test", "metadata.revision", "1"),
resource.TestCheckResourceAttr("helm_release.test", "status", release.StatusDeployed.String()),
resource.TestCheckResourceAttr("helm_release.test", "metadata.values",
"{\"foo\":\"(sensitive value)\"}"),
resource.TestCheckResourceAttr("helm_release.test", "metadata.values", `{"cloakedData":{"cloaked":"(sensitive value)"}}`),
func(s *terraform.State) error {
c, err := createKubernetesClient()
if err != nil {
return err
}

res, err := c.CoreV1().Secrets(namespace).Get(context.Background(), fmt.Sprintf("%s-test-chart", name), v1.GetOptions{})
if err != nil {
return err
}

v, ok := res.Data["cloaked"]
if !ok {
return fmt.Errorf("expected %q but secret value was nil", secretValue)
}

if string(v) != secretValue {
return fmt.Errorf("expected secret value to be %q but got %q", secretValue, v)
}
return nil
},
),
},
},
Expand Down Expand Up @@ -1036,8 +1058,8 @@ func testAccHelmReleaseConfigValues(resource, ns, name, chart, version string, v
func testAccHelmReleaseConfigSensitiveValue(resource, ns, name, chart, version, key, value string) string {
return fmt.Sprintf(`
resource "helm_release" "%s" {
name = %q
namespace = %q
name = %q
repository = %q
chart = %q
version = %q
Expand All @@ -1049,7 +1071,7 @@ func testAccHelmReleaseConfigSensitiveValue(resource, ns, name, chart, version,
}
]
}
`, resource, name, ns, testRepositoryURL, chart, version, key, value)
`, resource, ns, name, testRepositoryURL, chart, version, key, value)
}

func testAccHelmReleaseConfigSet(resource, ns, name, version, setValue string) string {
Expand Down Expand Up @@ -2461,6 +2483,7 @@ func testAccHelmReleaseRecomputeMetadataSet(resource, ns, name string) string {
}
`, resource, name, ns, resource)
}

func testAccHelmReleaseConfigSetLiteral(resource, ns, name, version string) string {
return fmt.Sprintf(`
resource "helm_release" "%s" {
Expand Down
6 changes: 6 additions & 0 deletions helm/testdata/charts/test-chart/templates/secrets.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
apiVersion: v1
kind: Secret
metadata:
name: {{ include "test-chart.fullname" . }}
data:
cloaked: {{ .Values.cloakedData.cloaked | b64enc }}
3 changes: 3 additions & 0 deletions helm/testdata/charts/test-chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,6 @@ nodeSelector: {}
tolerations: []

affinity: {}

cloakedData:
cloaked: secret
Loading