Add cosign-based signing, attestation, and verification for modelkits #1023
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,43 @@ | ||
| // Copyright 2025 The KitOps Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package attest | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| ) | ||
|
|
||
| func RunAttest(context context.Context, options *attestOptions) error { | ||
| _, err := exec.LookPath("cosign") | ||
| if err != nil { | ||
| fmt.Println() | ||
| return fmt.Errorf("cosign not found, please install cosign") | ||
| } | ||
| cmd := exec.CommandContext(context, "cosign", options.cosignArgs...) | ||
|
|
||
| cmd.Stdin = os.Stdin | ||
| cmd.Stderr = os.Stderr | ||
| cmd.Stdout = os.Stdout | ||
|
|
||
| err = cmd.Run() | ||
| if err != nil { | ||
| return fmt.Errorf("attestation failed: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or 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,81 @@ | ||
| // Copyright 2025 The KitOps Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package attest | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/kitops-ml/kitops/pkg/lib/completion" | ||
| "github.com/kitops-ml/kitops/pkg/lib/constants" | ||
| "github.com/kitops-ml/kitops/pkg/output" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| const ( | ||
| shortDesc = "Attest the supplied container image. Use the same flags as cosign." | ||
| example = `kit attest --predicate PREDICATE_FILE --key cosign.key --tlog-upload=false IMAGE_URI` | ||
| ) | ||
|
|
||
| type attestOptions struct { | ||
| configHome string | ||
| cosignArgs []string | ||
| } | ||
|
|
||
| func (opts *attestOptions) complete(ctx context.Context, args []string) error { | ||
| configHome, ok := ctx.Value(constants.ConfigKey{}).(string) | ||
| if !ok { | ||
| return fmt.Errorf("default config path not set on command context") | ||
| } | ||
| opts.configHome = configHome | ||
| opts.cosignArgs = args | ||
| return nil | ||
| } | ||
|
|
||
| func AttestCommand() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "attest [flags]", | ||
| Short: shortDesc, | ||
| Example: example, | ||
| RunE: runCommand(&attestOptions{}), | ||
| ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { | ||
| if len(args) >= 1 { | ||
| return nil, cobra.ShellCompDirectiveNoFileComp | ||
| } | ||
| return completion.GetLocalModelKitsCompletion(cmd.Context(), toComplete), cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveNoSpace | ||
| }, | ||
| DisableFlagParsing: true, | ||
| } | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func runCommand(opts *attestOptions) func(cmd *cobra.Command, args []string) error { | ||
| return func(cmd *cobra.Command, args []string) error { | ||
| args = append([]string{"attest"}, args...) | ||
| if err := opts.complete(cmd.Context(), args); err != nil { | ||
| return output.Fatalf("Invalid arguments: %w", err) | ||
| } | ||
|
|
||
| err := RunAttest(cmd.Context(), opts) | ||
| if err != nil { | ||
| return output.Fatalf("Failed to attest: %w", err) | ||
| } | ||
| output.Infof("Attestation successful") | ||
| return nil | ||
| } | ||
| } |
This file contains hidden or 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,82 @@ | ||
| // Copyright 2025 The KitOps Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package sign | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/kitops-ml/kitops/pkg/lib/completion" | ||
| "github.com/kitops-ml/kitops/pkg/lib/constants" | ||
| "github.com/kitops-ml/kitops/pkg/output" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| const ( | ||
| shortDesc = "Sign the supplied container image. Use the same flags as cosign." | ||
| example = `kit sign --key cosign.key --tlog-upload=false myimage:latest` | ||
| ) | ||
|
|
||
| type signOptions struct { | ||
| configHome string | ||
| cosignArgs []string | ||
| } | ||
|
|
||
| func SignCommand() *cobra.Command { | ||
|
|
||
| cmd := &cobra.Command{ | ||
| Use: "sign [flags]", | ||
| Short: shortDesc, | ||
| Example: example, | ||
| RunE: runCommand(&signOptions{}), | ||
| ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { | ||
| if len(args) >= 1 { | ||
| return nil, cobra.ShellCompDirectiveNoFileComp | ||
| } | ||
| return completion.GetLocalModelKitsCompletion(cmd.Context(), toComplete), cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveNoSpace | ||
| }, | ||
| DisableFlagParsing: true, | ||
| } | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func (opts *signOptions) complete(ctx context.Context, args []string) error { | ||
| configHome, ok := ctx.Value(constants.ConfigKey{}).(string) | ||
| if !ok { | ||
| return fmt.Errorf("default config path not set on command context") | ||
| } | ||
| opts.configHome = configHome | ||
| opts.cosignArgs = args | ||
| return nil | ||
| } | ||
|
|
||
| func runCommand(opts *signOptions) func(cmd *cobra.Command, args []string) error { | ||
| return func(cmd *cobra.Command, args []string) error { | ||
| args = append([]string{"sign"}, args...) | ||
| if err := opts.complete(cmd.Context(), args); err != nil { | ||
| return output.Fatalf("Invalid arguments: %w", err) | ||
| } | ||
|
|
||
| err := RunSign(cmd.Context(), opts) | ||
| if err != nil { | ||
| return output.Fatalf("Failed to sign: %w", err) | ||
| } | ||
| output.Infof("Modelkit signed") | ||
| return nil | ||
| } | ||
| } |
This file contains hidden or 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,44 @@ | ||
| // Copyright 2025 The KitOps Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package sign | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| ) | ||
|
|
||
| func RunSign(ctx context.Context, options *signOptions) error { | ||
| _, err := exec.LookPath("cosign") | ||
| if err != nil { | ||
| fmt.Println() | ||
| return fmt.Errorf("cosign not found, please install cosign") | ||
| } | ||
|
|
||
| cmd := exec.CommandContext(ctx, "cosign", options.cosignArgs...) | ||
|
Member
There was a problem hiding this comment. Commands will panic with "executable file not found" when cosign binary is not installed on the system. This needs pre-flight checks before making these calls. Also is there a possibility to use cosign as a library instead of an external CLI ?
Author
There was a problem hiding this comment. Looked into use of cosign as a library. Found cosign(github.com/sigstore/cosign/v2/pkg/cosign). But it doesn't have a high level api to sign or attest. Actual signing happens in internal packages. Reviewed sigstore-go, which currently doesn't have attestation creation support. |
||
|
|
||
| cmd.Stdin = os.Stdin | ||
| cmd.Stderr = os.Stderr | ||
| cmd.Stdout = os.Stdout | ||
|
|
||
| err = cmd.Run() | ||
| if err != nil { | ||
| return fmt.Errorf("signing failed: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or 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,104 @@ | ||
| // Copyright 2025 The KitOps Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package verify | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/kitops-ml/kitops/pkg/lib/completion" | ||
| "github.com/kitops-ml/kitops/pkg/lib/constants" | ||
| "github.com/kitops-ml/kitops/pkg/output" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| const ( | ||
| shortDesc = "Verify the ModelKit signature and attestation. Runs both verify and verify-attestation. Use --verify.* and --verify-attestation.* for flags specific to each step." | ||
| example = `kit verify --key cosign.pub --verify.insecure-ignore-tlog=true DIGEST` | ||
| ) | ||
|
|
||
| type verifyOptions struct { | ||
| configHome string | ||
| cosignArgs []string | ||
| } | ||
|
|
||
| func (opts *verifyOptions) complete(ctx context.Context, args []string) error { | ||
| configHome, ok := ctx.Value(constants.ConfigKey{}).(string) | ||
| if !ok { | ||
| return fmt.Errorf("default config path not set on command context") | ||
| } | ||
| opts.configHome = configHome | ||
| opts.cosignArgs = args | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func VerifyCommand() *cobra.Command { | ||
|
|
||
| cmd := &cobra.Command{ | ||
| Use: "verify [flags]", | ||
| Short: shortDesc, | ||
| Example: example, | ||
| RunE: runCommand(), | ||
| ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { | ||
| if len(args) >= 1 { | ||
| return nil, cobra.ShellCompDirectiveNoFileComp | ||
| } | ||
| return completion.GetLocalModelKitsCompletion(cmd.Context(), toComplete), cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveNoSpace | ||
| }, | ||
| DisableFlagParsing: true, | ||
| } | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func runCommand() func(cmd *cobra.Command, args []string) error { | ||
| return func(cmd *cobra.Command, args []string) error { | ||
| commands := []string{"verify", "verify-attestation"} | ||
| argsnew := [][]string{{}, {}} | ||
| for _, val := range args { | ||
| if val, ok := strings.CutPrefix(val, "--verify."); ok { | ||
| argsnew[0] = append(argsnew[0], "--"+val) | ||
| } else if val, ok := strings.CutPrefix(val, "--verify-attestation."); ok { | ||
| argsnew[1] = append(argsnew[1], "--"+val) | ||
| } else { | ||
| argsnew[0] = append(argsnew[0], val) | ||
| argsnew[1] = append(argsnew[1], val) | ||
| } | ||
| } | ||
|
|
||
| opts := make([]verifyOptions, 2) | ||
|
|
||
| for i := range 2 { | ||
| opts = append(opts, verifyOptions{}) | ||
| argsnew[i] = append([]string{commands[i]}, argsnew[i]...) | ||
| if err := opts[i].complete(cmd.Context(), argsnew[i]); err != nil { | ||
| return output.Fatalf("Invalid arguments: %w", err) | ||
| } | ||
| } | ||
|
|
||
| for i := range len(opts) { | ||
| err := RunVerify(cmd.Context(), opts[i]) | ||
| if err != nil { | ||
| return output.Fatalf("Failed to %s: %w", commands[i], err) | ||
| } | ||
| } | ||
| output.Infof("Verification successful") | ||
| return nil | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The implementations for
RunAttest,RunSign, andRunVerifyappear to be identical.