-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add experimental support for Cosign signing and verification (#296
) #295 *Description of changes:* Add COSIGN_PASSWORD env pass-through to allow users use Cosign. The feature should be experimental as it is experimental in Nerdctl. As Finch points to Nerdctl documentation today, users could see Cosign feature is experimental in Nerdctl documentation so will not mention experimental in Finch explicitly. *Testing done:* The tests only covers signing by push and verification by pull and run with the keys as MVP. The tests won't pass until the [changed](containerd/nerdctl#2109) is integrated to Finch. Tested locally that it can work with this change in Nerdctl. - [ X ] I've reviewed the guidance in CONTRIBUTING.md #### License Acceptance By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Signed-off-by: Ziwen Ning <ningziwe@amazon.com>
- Loading branch information
Showing
8 changed files
with
223 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| -----BEGIN ENCRYPTED COSIGN PRIVATE KEY----- | ||
| eyJrZGYiOnsibmFtZSI6InNjcnlwdCIsInBhcmFtcyI6eyJOIjozMjc2OCwiciI6 | ||
| OCwicCI6MX0sInNhbHQiOiIvYW9saHRuZEZTSHZsQjBZSnBTOVI1VlcyOE5HUmox | ||
| VkJNL2VDZWlvVEV3PSJ9LCJjaXBoZXIiOnsibmFtZSI6Im5hY2wvc2VjcmV0Ym94 | ||
| Iiwibm9uY2UiOiJGRGpKU1BTdnN4WmQ0N2orRlgvUjlPbVB0WlpkTVh4dyJ9LCJj | ||
| aXBoZXJ0ZXh0IjoibzlCOXJJbmZPNXZaeE9PMFBSdFdjYlNUQmxibXA5OVVWTnEv | ||
| ZFhJN0hzd09yZFpVeTA1MmdUT3AyVkFsSjk2aTNFZitiY095QlU1MWt1UDd2R2gy | ||
| U1ljU2VkbWQvejEzM3owNUovZytjUll3bHRuNkowOTgwZ0xUR1NKdWxobFNIYWpC | ||
| Q25LS1RmY2tIb0dUU0dsZkU1aFk1UFdyRGlQTmc3VVA4bk1lc2JCWlRPMnFjaUdE | ||
| bTI0a21ON1RIOEljRlJ4T3Y1NkFNWm1tTUE9PSJ9 | ||
| -----END ENCRYPTED COSIGN PRIVATE KEY----- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| -----BEGIN PUBLIC KEY----- | ||
| MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEfkODzHTFabSz0T+X758IqIB6pi3u | ||
| Km4JQCcEDFv94s6J4msvNOhmiAv3PQ/b9dutQ7QODWJAdm3cp6CMd87e1w== | ||
| -----END PUBLIC KEY----- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| -----BEGIN ENCRYPTED COSIGN PRIVATE KEY----- | ||
| eyJrZGYiOnsibmFtZSI6InNjcnlwdCIsInBhcmFtcyI6eyJOIjozMjc2OCwiciI6 | ||
| OCwicCI6MX0sInNhbHQiOiJiYlVrSzkzdmY2dEhIM1czNTJ1UWM2ajNidzduUjdW | ||
| cTdReHJaRVlJYXM4PSJ9LCJjaXBoZXIiOnsibmFtZSI6Im5hY2wvc2VjcmV0Ym94 | ||
| Iiwibm9uY2UiOiJBWlhuSThncGhjbzdFdDBVOGhzKy91Tk5OdFpyTWNBOSJ9LCJj | ||
| aXBoZXJ0ZXh0IjoiaVJsUG9IRlJnQmJTamc2NnhvTTM4dm0vNExwelJXeUlKZi8x | ||
| dFIraEJ3dHdRMTQwZjBsQlpHdHRRMXZYcEE4UktHK09vTnNUcFNUSGh6R2phd3VN | ||
| ZXNzaVdsWkxHVTVjSTU5UVZ4TW40bGI4ME5iNWF2NlA5ZjVYT2x2aHhXbnMzUnpt | ||
| R091L0hCOHd1ZnBUUnBlQlZNLzZkZmFyV05ZbE92VzRYaWVvZXNEQ0hOV3JWbzFJ | ||
| WWdCbysxTEFYbzdYWkQ4cXNVWFdJd3ZONkE9PSJ9 | ||
| -----END ENCRYPTED COSIGN PRIVATE KEY----- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| -----BEGIN PUBLIC KEY----- | ||
| MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAERyYVqiPX1IGvTiAuJCZIOfPllOm/ | ||
| HTi7DaswFLwNXVOOC7FLP3L9YzQ0q24bFBqkSQqgWeycKsOOPCbF0nMLHQ== | ||
| -----END PUBLIC KEY----- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package container | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/onsi/ginkgo/v2" | ||
| "github.com/onsi/gomega" | ||
| "github.com/runfinch/common-tests/command" | ||
| "github.com/runfinch/common-tests/ffs" | ||
| "github.com/runfinch/common-tests/fnet" | ||
| "github.com/runfinch/common-tests/option" | ||
| ) | ||
|
|
||
| const ( | ||
| alpineImage = "public.ecr.aws/docker/library/alpine:latest" | ||
| registryImage = "public.ecr.aws/docker/library/registry:latest" | ||
| ) | ||
|
|
||
| var testCosign = func(o *option.Option) { | ||
| ginkgo.Describe("Cosign", func() { | ||
| var buildContext string | ||
| var port int | ||
| var registry string | ||
| var tag string | ||
| ginkgo.BeforeEach(func() { | ||
| command.RemoveAll(o) | ||
| buildContext = ffs.CreateBuildContext(fmt.Sprintf(`FROM %s | ||
| CMD ["echo", "bar"] | ||
| `, alpineImage)) | ||
| ginkgo.DeferCleanup(os.RemoveAll, buildContext) | ||
| filename := "htpasswd" | ||
| // The htpasswd is generated by | ||
| // `<subject> run --entrypoint htpasswd public.ecr.aws/docker/library/httpd:2 -Bbn testUser testPassword`. | ||
| // We don't want to generate it on the fly because: | ||
| // 1. Pulling the httpd image can take a long time, sometimes even more 10 seconds. | ||
| // 2. It's unlikely that we will have to update this in the future. | ||
| // 3. It's not the thing we want to validate by the functional tests. We only want the output produced by it. | ||
| //nolint:gosec // This password is only used for testing purpose. | ||
| htpasswd := "testUser:$2y$05$wE0sj3r9O9K9q7R0MXcfPuIerl/06L1IsxXkCuUr3QZ8lHWwicIdS" | ||
| htpasswdDir := filepath.Dir(ffs.CreateTempFile(filename, htpasswd)) | ||
| ginkgo.DeferCleanup(os.RemoveAll, htpasswdDir) | ||
| port = fnet.GetFreePort() | ||
| command.Run(o, "run", | ||
| "-dp", fmt.Sprintf("%d:5000", port), | ||
| "--name", "registry", | ||
| "-v", fmt.Sprintf("%s:/auth", htpasswdDir), | ||
| "-e", "REGISTRY_AUTH=htpasswd", | ||
| "-e", "REGISTRY_AUTH_HTPASSWD_REALM=Registry Realm", | ||
| "-e", fmt.Sprintf("REGISTRY_AUTH_HTPASSWD_PATH=/auth/%s", filename), | ||
| registryImage) | ||
| registry = fmt.Sprintf(`localhost:%d`, port) | ||
| tag = fmt.Sprintf(`%s/test-login:tag`, registry) | ||
| }) | ||
|
|
||
| ginkgo.AfterEach(func() { | ||
| command.RemoveAll(o) | ||
| }) | ||
|
|
||
| ginkgo.It("should succeed to verify the signature of the image only when it is signed with the matched key", func() { | ||
| command.Run(o, "build", "-t", tag, buildContext) | ||
| gomega.Expect(os.Setenv("COSIGN_PASSWORD", "test-1")).To(gomega.Succeed()) | ||
| command.Run(o, "login", registry, "-u", "testUser", "-p", "testPassword") | ||
| ginkgo.DeferCleanup(func() { | ||
| command.Run(o, "logout", registry) | ||
| }) | ||
| command.Run(o, "push", "--sign=cosign", "--cosign-key=./cosign_data/test-1.key", tag) | ||
| command.Run(o, "pull", "--verify=cosign", "--cosign-key=./cosign_data/test-1.pub", tag) | ||
| command.Run(o, "run", "-d", "--verify=cosign", "--cosign-key=./cosign_data/test-1.pub", tag) | ||
|
|
||
| gomega.Expect(command.RunWithoutSuccessfulExit(o, "pull", "--verify=cosign", "--cosign-key=./cosign_data/test-2.pub", | ||
| tag).Err.Contents()).Should(gomega.ContainSubstring("no matching signatures")) | ||
| gomega.Expect(command.RunWithoutSuccessfulExit(o, "run", "-d", "--verify=cosign", "--cosign-key=./cosign_data/test-2.pub", | ||
| tag).Err.Contents()).Should(gomega.ContainSubstring("no matching signatures")) | ||
| gomega.Expect(command.RunWithoutSuccessfulExit(o, "pull", "--verify=cosign", "--cosign-key=./cosign_data/test-2.pub", | ||
| alpineImage).Err.Contents()).Should(gomega.ContainSubstring("no matching signatures")) | ||
| gomega.Expect(command.RunWithoutSuccessfulExit(o, "run", "-d", "--verify=cosign", "--cosign-key=./cosign_data/test-2.pub", | ||
| alpineImage).Err.Contents()).Should(gomega.ContainSubstring("no matching signatures")) | ||
| }) | ||
| }) | ||
| } |