package spec import ( "regexp" "testing" "github.com/google/go-cmp/cmp" "github.com/google/go-tpm-tools/launcher/internal/experiments" "github.com/google/go-tpm-tools/launcher/internal/launchermount" "github.com/google/go-tpm-tools/verifier" ) func TestLaunchSpecUnmarshalJSONHappyCases(t *testing.T) { baseWant := LaunchSpec{ ImageRef: "docker.io/library/hello-world:latest", SignedImageRepos: []string{"docker.io/library/hello-world", "gcr.io/cloudrun/hello"}, RestartPolicy: Always, Cmd: []string{"--foo", "--bar", "--baz"}, Envs: []EnvVar{{"foo", "bar"}}, ImpersonateServiceAccounts: []string{"sv1@developer.gserviceaccount.com", "sv2@developer.gserviceaccount.com"}, LogRedirect: Everywhere, MonitoringEnabled: MemoryOnly, DevShmSize: 234234, Mounts: []launchermount.Mount{launchermount.TmpfsMount{Destination: "/tmpmount", Size: 0}, launchermount.TmpfsMount{Destination: "/sized", Size: 222}}, ITAConfig: verifier.ITAConfig{ ITARegion: "US", ITAKey: "test-api-key", }, Experiments: experiments.Experiments{ EnableItaVerifier: true, }, GcaAddress: "https://confidentialcomputing.googleapis.com", InstallGpuDriver: true, DisableGcaRefresh: false, } var testCases = []struct { testName string mdsJSON string modifyWant func(LaunchSpec) LaunchSpec }{ { testName: "HappyCase", mdsJSON: `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"true", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "gca-service-env":"STAGING", "tee-install-gpu-driver":"true" }`, modifyWant: func(ls LaunchSpec) LaunchSpec { ls.GcaAddress = "https://staging-confidentialcomputing.sandbox.googleapis.com" return ls }, }, { testName: "HappyCaseWithExtraUnknownFields", mdsJSON: `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-unknown":"unknown", "unknown":"unknown", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"TRUE", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "tee-install-gpu-driver":"true" }`, modifyWant: func(ls LaunchSpec) LaunchSpec { ls.GcaAddress = "" return ls }, }, { testName: "GcaServiceSetToProd", mdsJSON: `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-unknown":"unknown", "unknown":"unknown", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"TRUE", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "gca-service-env":"prod", "tee-install-gpu-driver":"true" }`, modifyWant: func(ls LaunchSpec) LaunchSpec { return ls }, }, { testName: "GcaServiceEnvTramplesTeeAttestationServiceEndpoint", mdsJSON: `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-unknown":"unknown", "unknown":"unknown", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"TRUE", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "gca-service-env":"staging", "tee-install-gpu-driver":"true" }`, modifyWant: func(ls LaunchSpec) LaunchSpec { ls.GcaAddress = "https://staging-confidentialcomputing.sandbox.googleapis.com" return ls }, }, { testName: "DisableGcaRefreshSetToTrue", mdsJSON: `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"true", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "tee-install-gpu-driver":"true", "tee-disable-gca-refresh":"true" }`, modifyWant: func(ls LaunchSpec) LaunchSpec { ls.GcaAddress = "" ls.DisableGcaRefresh = true return ls }, }, } for _, testcase := range testCases { t.Run(testcase.testName, func(t *testing.T) { spec := &LaunchSpec{} spec.Experiments = experiments.Experiments{ EnableItaVerifier: true, } if err := spec.UnmarshalJSON([]byte(testcase.mdsJSON)); err != nil { t.Fatal(err) } want := testcase.modifyWant(baseWant) if !cmp.Equal(spec, &want) { t.Errorf("LaunchSpec UnmarshalJSON got %+v, want %+v", spec, want) } }) } } func TestLaunchSpecUnmarshalJSONBadInput(t *testing.T) { var testCases = []struct { testName string mdsJSON string }{ // not likely to happen for MDS { "BadJSON", `{ BadJSONFormat }`, }, // when there is no MDS values { "EmptyJSON", `{}`, }, // not likely to happen, since MDS will always use string as the value { "JSONWithPrimitives", `{ "tee-env-bool":true, "tee-image-reference":"docker.io/library/hello-world:latest" }`, }, { "WrongRestartPolicy", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-restart-policy":"noway", }`, }, { "WrongLogRedirectLocation", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-container-log-redirect":"badideas", }`, }, { "Memory and Health Monitoring both specified", `{ "tee-monitoring-memory-enable":"false", "tee-monitoring-health-enable":"false", }`, }, { "GCA endpoint not within map", `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"true", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "gca-service-env":"https://testhost.com" }`, }, { "EmptyStringAsGcaEndpoint", `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-image-reference":"docker.io/library/hello-world:latest", "tee-signed-image-repos":"docker.io/library/hello-world,gcr.io/cloudrun/hello", "tee-restart-policy":"Always", "tee-impersonate-service-accounts":"sv1@developer.gserviceaccount.com,sv2@developer.gserviceaccount.com", "tee-container-log-redirect":"true", "tee-monitoring-memory-enable":"true", "tee-dev-shm-size-kb":"234234", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount;type=tmpfs,source=tmpfs,destination=/sized,size=222", "ita-region":"US", "ita-api-key":"test-api-key", "gca-service-env":"" }`, }, { "EmptyStringAsDisableGcaRefresh", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-disable-gca-refresh":"badvalue" }`, }, } for _, testcase := range testCases { t.Run(testcase.testName, func(t *testing.T) { spec := &LaunchSpec{} if err := spec.UnmarshalJSON([]byte(testcase.mdsJSON)); err == nil { t.Fatal("expected JSON parsing err") } }) } } func TestLaunchSpecUnmarshalJSONWithDefaultValue(t *testing.T) { mdsJSON := `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-impersonate-service-accounts":"", "tee-signed-image-repos":"", "tee-container-log-redirect":"", "tee-restart-policy":"", "tee-monitoring-memory-enable":"", "tee-mount":"" }` spec := &LaunchSpec{} if err := spec.UnmarshalJSON([]byte(mdsJSON)); err != nil { t.Fatal(err) } want := &LaunchSpec{ ImageRef: "docker.io/library/hello-world:latest", RestartPolicy: Never, LogRedirect: Nowhere, MonitoringEnabled: None, GcaAddress: "", InstallGpuDriver: false, DisableGcaRefresh: false, } if !cmp.Equal(spec, want) { t.Errorf("LaunchSpec UnmarshalJSON got %+v, want %+v", spec, want) } } func TestLaunchSpecUnmarshalJSONWithoutImageReference(t *testing.T) { mdsJSON := `{ "tee-cmd":"[\"--foo\",\"--bar\",\"--baz\"]", "tee-env-foo":"bar", "tee-restart-policy":"Never" }` spec := &LaunchSpec{} if err := spec.UnmarshalJSON([]byte(mdsJSON)); err == nil || err != errImageRefNotSpecified { t.Errorf("got %v error, but expected %v error", err, errImageRefNotSpecified) } } func TestLaunchSpecUnmarshalJSONWithTmpfsMounts(t *testing.T) { var testCases = []struct { testName string mdsJSON string wantDst string wantSz uint64 }{ { "Empty Mounts", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"" }`, "", 0, }, { "Tmpfs", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount" }`, "/tmpmount", 0, }, { "Tmpfs Sized", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount,size=78987" }`, "/tmpmount", 78987, }, } for _, testcase := range testCases { t.Run(testcase.testName, func(t *testing.T) { spec := &LaunchSpec{} if err := spec.UnmarshalJSON([]byte(testcase.mdsJSON)); err != nil { t.Errorf("got %v error, but expected nil error", err) } }) } } func TestLaunchSpecUnmarshalJSONWithBadMounts(t *testing.T) { var testCases = []struct { testName string mdsJSON string errMatch string }{ { "Unknown Type", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=hallo" }`, "found unknown or unspecified mount type", }, { "Not k=v", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source" }`, "failed to parse mount option", }, { "Unknown Option", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount,size=123,foo=bar" }`, "found unknown mount option", }, { "Tmpfs Bad Source", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source=src,destination=/tmpmount" }`, "received wrong mount source", }, { "Tmpfs No Destination", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source=tmpfs" }`, "mount type \"tmpfs\" must have destination specified", }, { "Tmpfs Size Not Int", `{ "tee-image-reference":"docker.io/library/hello-world:latest", "tee-mount":"type=tmpfs,source=tmpfs,destination=/tmpmount,size=foo" }`, "failed to convert size option", }, } for _, testcase := range testCases { t.Run(testcase.testName, func(t *testing.T) { spec := &LaunchSpec{} err := spec.UnmarshalJSON([]byte(testcase.mdsJSON)) if match, _ := regexp.MatchString(testcase.errMatch, err.Error()); !match { t.Errorf("got %v error, but expected %v error", err, testcase.errMatch) } }) } }