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

cli: make default WorkloadSecretIDs unique per k8s object #1127

Merged
merged 2 commits into from
Jan 9, 2025
Merged

cli: make default WorkloadSecretIDs unique per k8s object #1127

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
c696207
kubeapi: return pointers to make them type-assertable
burgerdev Jan 8, 2025
540b159
cli: derive workload secret ID from GVK, namespace and name
burgerdev Jan 8, 2025
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
61 changes: 41 additions & 20 deletions cli/cmd/policies.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,19 @@ import (
"log/slog"
"os"
"slices"
"strings"

"github.com/edgelesssys/contrast/internal/kubeapi"
"github.com/edgelesssys/contrast/internal/manifest"
"k8s.io/apimachinery/pkg/runtime/schema"
)

type k8sObject interface {
GetName() string
GetNamespace() string
GetObjectKind() schema.ObjectKind
}

func policiesFromKubeResources(yamlPaths []string) ([]deployment, error) {
var kubeObjs []any
for _, path := range yamlPaths {
Expand All @@ -29,30 +37,34 @@ func policiesFromKubeResources(yamlPaths []string) ([]deployment, error) {

var deployments []deployment
for _, objAny := range kubeObjs {
var name, annotation, role string
meta, ok := objAny.(k8sObject)
if !ok {
continue
}
name := meta.GetName()
namespace := orDefault(meta.GetNamespace(), "default")

gvk := meta.GetObjectKind().GroupVersionKind()
workloadSecretID := strings.Join([]string{orDefault(gvk.Group, "core"), gvk.Version, gvk.Kind, namespace, name}, "/")

var annotation, role string
switch obj := objAny.(type) {
case kubeapi.Pod:
name = obj.Name
case *kubeapi.Pod:
annotation = obj.Annotations[kataPolicyAnnotationKey]
role = obj.Annotations[contrastRoleAnnotationKey]
case kubeapi.Deployment:
name = obj.Name
case *kubeapi.Deployment:
annotation = obj.Spec.Template.Annotations[kataPolicyAnnotationKey]
role = obj.Spec.Template.Annotations[contrastRoleAnnotationKey]
case kubeapi.ReplicaSet:
name = obj.Name
case *kubeapi.ReplicaSet:
annotation = obj.Spec.Template.Annotations[kataPolicyAnnotationKey]
role = obj.Spec.Template.Annotations[contrastRoleAnnotationKey]
case kubeapi.StatefulSet:
name = obj.Name
case *kubeapi.StatefulSet:
annotation = obj.Spec.Template.Annotations[kataPolicyAnnotationKey]
role = obj.Spec.Template.Annotations[contrastRoleAnnotationKey]
case kubeapi.DaemonSet:
name = obj.Name
case *kubeapi.DaemonSet:
annotation = obj.Spec.Template.Annotations[kataPolicyAnnotationKey]
role = obj.Spec.Template.Annotations[contrastRoleAnnotationKey]
case kubeapi.Job:
name = obj.Name
case *kubeapi.Job:
annotation = obj.Spec.Template.Annotations[kataPolicyAnnotationKey]
role = obj.Spec.Template.Annotations[contrastRoleAnnotationKey]
}
Expand All @@ -67,9 +79,10 @@ func policiesFromKubeResources(yamlPaths []string) ([]deployment, error) {
return nil, fmt.Errorf("failed to parse policy %s: %w", name, err)
}
deployments = append(deployments, deployment{
name: name,
policy: policy,
role: role,
name: name,
policy: policy,
role: role,
workloadSecretID: workloadSecretID,
})
}

Expand All @@ -86,7 +99,7 @@ func manifestPolicyMapFromPolicies(policies []deployment) (map[manifest.HexStrin
}
continue
}
entry := manifest.PolicyEntry{SANs: depl.DNSNames(), WorkloadSecretID: depl.name}
entry := manifest.PolicyEntry{SANs: depl.DNSNames(), WorkloadSecretID: depl.workloadSecretID}
policyHashes[depl.policy.Hash()] = entry
}
return policyHashes, nil
Expand Down Expand Up @@ -128,11 +141,19 @@ func getCoordinatorPolicyHash(policies []deployment, log *slog.Logger) string {
}

type deployment struct {
name string
policy manifest.Policy
role string
name string
policy manifest.Policy
role string
workloadSecretID string
}

func (d deployment) DNSNames() []string {
return []string{d.name, "*"}
}

func orDefault(s, d string) string {
if s == "" {
return d
}
return s
}
21 changes: 12 additions & 9 deletions cli/cmd/policies_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,10 @@ func TestPoliciesFromKubeResources(t *testing.T) {
},
expectedOutput: []deployment{
{
name: "test",
policy: manifest.Policy([]byte(`valid-agent-policy`)),
role: "coordinator",
name: "test",
policy: manifest.Policy([]byte(`valid-agent-policy`)),
role: "coordinator",
workloadSecretID: "apps/v1/Deployment/default/test",
},
},
},
Expand All @@ -101,14 +102,16 @@ func TestPoliciesFromKubeResources(t *testing.T) {
},
expectedOutput: []deployment{
{
name: "test",
policy: manifest.Policy([]byte(`valid-agent-policy`)),
role: "coordinator",
name: "test",
policy: manifest.Policy([]byte(`valid-agent-policy`)),
role: "coordinator",
workloadSecretID: "apps/v1/Deployment/default/test",
},
{
name: "another-pod",
policy: manifest.Policy([]byte(`valid-agent-policy`)),
role: "worker",
name: "another-pod",
policy: manifest.Policy([]byte(`valid-agent-policy`)),
role: "worker",
workloadSecretID: "core/v1/Pod/default/another-pod",
},
},
},
Expand Down
56 changes: 26 additions & 30 deletions e2e/workloadsecret/workloadsecret_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ func TestWorkloadSecrets(t *testing.T) {
require.Equal(webWorkloadSecretBytes, otherWebWorkloadSecretBytes)
})

var emojiWorkloadSecretBytes []byte
t.Run("workload secret seeds differ between deployments by default", func(t *testing.T) {
require := require.New(t)

Expand All @@ -125,7 +124,7 @@ func TestWorkloadSecrets(t *testing.T) {
stdout, stderr, err := ct.Kubeclient.Exec(ctx, ct.Namespace, emojiPods[0].Name, []string{"/bin/sh", "-c", "cat /contrast/secrets/workload-secret-seed"})
require.NoError(err, "stderr: %q", stderr)
require.NotEmpty(stdout)
emojiWorkloadSecretBytes, err = hex.DecodeString(stdout)
emojiWorkloadSecretBytes, err := hex.DecodeString(stdout)
require.NoError(err)
require.Len(emojiWorkloadSecretBytes, constants.SecretSeedSize)
require.NotEqual(webWorkloadSecretBytes, emojiWorkloadSecretBytes)
Expand All @@ -136,38 +135,35 @@ func TestWorkloadSecrets(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), ct.FactorPlatformTimeout(60*time.Second))
defer cancel()

ct.PatchManifest(t, patchWorkloadSecretID("web", "emoji"))
ct.PatchManifest(t, func(m manifest.Manifest) manifest.Manifest {
for key, policy := range m.Policies {
policy.WorkloadSecretID = "custom"
m.Policies[key] = policy
}
return m
})

t.Run("set", ct.Set)
require.NoError(ct.Kubeclient.Restart(ctx, kubeclient.Deployment{}, ct.Namespace, "web"))
require.NoError(ct.Kubeclient.WaitFor(ctx, kubeclient.Ready, kubeclient.Deployment{}, ct.Namespace, "web"))

webPods, err = ct.Kubeclient.PodsFromDeployment(ctx, ct.Namespace, "web")
require.NoError(err)
require.Len(webPods, 2, "pod not found: %s/%s", ct.Namespace, "web")

stdout, stderr, err := ct.Kubeclient.Exec(ctx, ct.Namespace, webPods[0].Name, []string{"/bin/sh", "-c", "cat /contrast/secrets/workload-secret-seed"})
require.NoError(err, "stderr: %q", stderr)
require.NotEmpty(stdout)
webWorkloadSecretBytes, err = hex.DecodeString(stdout)
require.NoError(err)
require.Len(webWorkloadSecretBytes, constants.SecretSeedSize)
require.Equal(webWorkloadSecretBytes, emojiWorkloadSecretBytes)
})
}

// patchWorkloadSecretID returns a PatchManifestFunc which overwrites the expectedWorkloadSecretID with the patchWorkloadSecretID
// in a manifest.
func patchWorkloadSecretID(expectedWorkloadSecretID string, patchWorkloadSecretID string) contrasttest.PatchManifestFunc {
return func(m manifest.Manifest) manifest.Manifest {
for key, policy := range m.Policies {
if policy.WorkloadSecretID == expectedWorkloadSecretID {
policy.WorkloadSecretID = patchWorkloadSecretID
m.Policies[key] = policy
}
var secrets [][]byte
for _, deploy := range []string{"web", "emoji"} {
require.NoError(ct.Kubeclient.Restart(ctx, kubeclient.Deployment{}, ct.Namespace, deploy))
require.NoError(ct.Kubeclient.WaitFor(ctx, kubeclient.Ready, kubeclient.Deployment{}, ct.Namespace, deploy))

pods, err := ct.Kubeclient.PodsFromDeployment(ctx, ct.Namespace, deploy)
require.NoError(err)
require.GreaterOrEqual(len(pods), 1, "pod not found: %s/%s", ct.Namespace, deploy)

stdout, stderr, err := ct.Kubeclient.Exec(ctx, ct.Namespace, pods[0].Name, []string{"/bin/sh", "-c", "cat /contrast/secrets/workload-secret-seed"})
require.NoError(err, "stderr: %q", stderr)
require.NotEmpty(stdout)
secretBytes, err := hex.DecodeString(stdout)
require.NoError(err)
secrets = append(secrets, secretBytes)
}
return m
}
require.Len(secrets, 2)
require.Equal(secrets[0], secrets[1])
})
}

func TestMain(m *testing.M) {
Expand Down
14 changes: 7 additions & 7 deletions internal/kubeapi/kubeapi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,49 +51,49 @@ func UnmarshalK8SResources(data []byte) ([]any, error) {
if err != nil {
return nil, err
}
result = append(result, pod)
result = append(result, &pod)
case "Deployment":
var deployment appsv1.Deployment
err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.UnstructuredContent(), &deployment)
if err != nil {
return nil, err
}
result = append(result, deployment)
result = append(result, &deployment)
case "StatefulSet":
var statefulSet appsv1.StatefulSet
err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.UnstructuredContent(), &statefulSet)
if err != nil {
return nil, err
}
result = append(result, statefulSet)
result = append(result, &statefulSet)
case "ReplicaSet":
var replicaSet appsv1.ReplicaSet
err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.UnstructuredContent(), &replicaSet)
if err != nil {
return nil, err
}
result = append(result, replicaSet)
result = append(result, &replicaSet)
case "DaemonSet":
var daemonSet appsv1.DaemonSet
err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.UnstructuredContent(), &daemonSet)
if err != nil {
return nil, err
}
result = append(result, daemonSet)
result = append(result, &daemonSet)
case "Job":
var job batchv1.Job
err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.UnstructuredContent(), &job)
if err != nil {
return nil, err
}
result = append(result, job)
result = append(result, &job)
case "CronJob":
var cronJob batchv1.CronJob
err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.UnstructuredContent(), &cronJob)
if err != nil {
return nil, err
}
result = append(result, cronJob)
result = append(result, &cronJob)
}
}
return result, nil
Expand Down
10 changes: 5 additions & 5 deletions internal/kubeapi/kubeapi_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ metadata:
`,
},
"pod": {
wantTypes: []any{Pod{}},
wantTypes: []any{&Pod{}},
resources: `
apiVersion: v1
kind: Pod
Expand All @@ -35,7 +35,7 @@ metadata:
`,
},
"deployment, ignored service, daemonset": {
wantTypes: []any{Deployment{}, DaemonSet{}},
wantTypes: []any{&Deployment{}, &DaemonSet{}},
resources: `
apiVersion: apps/v1
kind: Deployment
Expand All @@ -54,7 +54,7 @@ metadata:
`,
},
"statefulset, replicaset": {
wantTypes: []any{StatefulSet{}, ReplicaSet{}},
wantTypes: []any{&StatefulSet{}, &ReplicaSet{}},
resources: `
apiVersion: apps/v1
kind: StatefulSet
Expand All @@ -68,7 +68,7 @@ metadata:
`,
},
"job": {
wantTypes: []any{Job{}},
wantTypes: []any{&Job{}},
resources: `
apiVersion: batch/v1
kind: Job
Expand All @@ -77,7 +77,7 @@ metadata:
`,
},
"cronjob": {
wantTypes: []any{CronJob{}},
wantTypes: []any{&CronJob{}},
resources: `
apiVersion: batch/v1
kind: CronJob
Expand Down