Migrate generate to cobra.

cmd/cosign/cli/commands.go

@@ -120,6 +120,7 @@ func New() *cobra.Command {
 
 	// Add sub-commands.
 	addPublicKey(cmd)
+	addGenerate(cmd)
 	addSign(cmd)
 	addSignBlob(cmd)
 	addGenerateKeyPair(cmd)

cmd/cosign/cli/generate.go

@@ -0,0 +1,60 @@
+//
+// Copyright 2021 The Sigstore 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.
+
+package cli
+
+import (
+	"flag"
+
+	"github.com/spf13/cobra"
+
+	"github.com/sigstore/cosign/cmd/cosign/cli/generate"
+	"github.com/sigstore/cosign/cmd/cosign/cli/options"
+)
+
+func addGenerate(topLevel *cobra.Command) {
+	o := &options.GenerateOptions{}
+
+	cmd := &cobra.Command{
+		Use:   "generate",
+		Short: "Generates (unsigned) signature payloads from the supplied container image.\ncosign generate [--a key=value] <image uri>",
+		Long: `Generates an unsigned payload from the supplied container image and flags.
+This payload matches the one generated by the "cosign sign" command and can be used if you need
+to sign payloads with your own tooling or algorithms.`,
+		Example: `
+# Generate a simple payload for an image
+	cosign generate <IMAGE>
+
+	# Generate a payload with specific annotations
+	cosign generate -a foo=bar <IMAGE>
+
+	# Use this payload in another tool
+	gpg --output image.sig --detach-sig <(cosign generate <IMAGE>)`,
+
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if len(args) != 1 {
+				return flag.ErrHelp
+			}
+			annotationMap, err := o.AnnotationsMap()
+			if err != nil {
+				return err
+			}
+			return generate.GenerateCmd(cmd.Context(), o.RegistryOpts, args[0], annotationMap.Annotations, cmd.OutOrStdout())
+		},
+	}
+
+	options.AddGenerateOptions(cmd, o)
+	topLevel.AddCommand(cmd)
+}

cmd/cosign/cli/generate/generate.go

@@ -20,7 +20,6 @@ import (
 	"flag"
 	"fmt"
 	"io"
-	"os"
 
 	"github.com/google/go-containerregistry/pkg/name"
 	"github.com/peterbourgon/ff/v3/ffcli"
@@ -31,6 +30,8 @@ import (
 	"github.com/sigstore/sigstore/pkg/signature/payload"
 )
 
+// Generate subcommand for ffcli.
+// Deprecated: this will be deleted when the migration from ffcli to cobra is done.
 func Generate() *ffcli.Command {
 	var (
 		flagset     = flag.NewFlagSet("cosign generate", flag.ExitOnError)
@@ -49,7 +50,7 @@ This payload matches the one generated by the "cosign sign" command and can be u
 to sign payloads with your own tooling or algorithms.
 
 EXAMPLES
-	# Generage a simple payload for an image
+	# Generate a simple payload for an image
 	cosign generate <IMAGE>
 
 	# Generate a payload with specific annotations
@@ -59,10 +60,7 @@ EXAMPLES
 	gpg --output image.sig --detach-sig <(cosign generate <IMAGE>)`,
 		FlagSet: flagset,
 		Exec: func(ctx context.Context, args []string) error {
-			if len(args) != 1 {
-				return flag.ErrHelp
-			}
-			return GenerateCmd(ctx, regOpts, args[0], annotations.Annotations, os.Stdout)
+			panic("this command is now implemented in cobra.")
 		},
 	}
 }

cmd/cosign/cli/options/annotations.go

@@ -0,0 +1,51 @@
+//
+// Copyright 2021 The Sigstore 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.
+
+package options
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+
+	sigs "github.com/sigstore/cosign/pkg/signature"
+)
+
+// AnnotationOptions is the top level wrapper for the annotations.
+type AnnotationOptions struct {
+	Annotations []string
+}
+
+func (s *AnnotationOptions) AnnotationsMap() (sigs.AnnotationsMap, error) {
+	ann := sigs.AnnotationsMap{}
+	for _, a := range s.Annotations {
+		kv := strings.Split(a, "=")
+		if len(kv) != 2 {
+			return ann, fmt.Errorf("unable to parse annotation: %s", a)
+		}
+		if ann.Annotations == nil {
+			ann.Annotations = map[string]interface{}{}
+		}
+		ann.Annotations[kv[0]] = kv[1]
+	}
+	return ann, nil
+}
+
+// AddAnnotationOptions adds annotation options to cmd.
+func AddAnnotationOptions(cmd *cobra.Command, o *AnnotationOptions) {
+	cmd.Flags().StringSliceVarP(&o.Annotations, "annotations", "a", nil,
+		"extra key=value pairs to sign")
+}

cmd/cosign/cli/options/sign_test.go → cmd/cosign/cli/options/annotations_test.go

@@ -23,7 +23,7 @@ import (
 	"github.com/sigstore/cosign/pkg/signature"
 )
 
-func TestSignOptions_AnnotationsMap(t *testing.T) {
+func TestAnnotationOptions_AnnotationsMap(t *testing.T) {
 	tests := []struct {
 		name        string
 		annotations []string
@@ -47,7 +47,7 @@ func TestSignOptions_AnnotationsMap(t *testing.T) {
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			s := &SignOptions{
+			s := &AnnotationOptions{
 				Annotations: tt.annotations,
 			}
 			got, err := s.AnnotationsMap()

cmd/cosign/cli/options/generate.go

@@ -0,0 +1,34 @@
+//
+// Copyright 2021 The Sigstore 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.
+
+package options
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// GenerateOptions is the top level wrapper for the generate command.
+type GenerateOptions struct {
+	AnnotationOptions
+	RegistryOpts RegistryOpts
+}
+
+// AddGenerateOptions adds the generate command options to cmd.
+func AddGenerateOptions(cmd *cobra.Command, o *GenerateOptions) {
+	AddAnnotationOptions(cmd, &o.AnnotationOptions)
+
+	cmd.Flags().BoolVar(&o.RegistryOpts.AllowInsecure, "allow-insecure-registry", false,
+		"whether to allow insecure connections to registries. Don't use this for anything but testing")
+}

cmd/cosign/cli/options/sign.go

@@ -16,12 +16,7 @@
 package options
 
 import (
-	"fmt"
-	"strings"
-
 	"github.com/spf13/cobra"
-
-	sigs "github.com/sigstore/cosign/pkg/signature"
 )
 
 // SignOptions is the top level wrapper for the sign command.
@@ -40,25 +35,10 @@ type SignOptions struct {
 	OIDC       OIDCOptions
 	Attachment string
 
-	Annotations  []string
+	AnnotationOptions
 	RegistryOpts RegistryOpts
 }
 
-func (s *SignOptions) AnnotationsMap() (sigs.AnnotationsMap, error) {
-	ann := sigs.AnnotationsMap{}
-	for _, a := range s.Annotations {
-		kv := strings.Split(a, "=")
-		if len(kv) != 2 {
-			return ann, fmt.Errorf("unable to parse annotation: %s", a)
-		}
-		if ann.Annotations == nil {
-			ann.Annotations = map[string]interface{}{}
-		}
-		ann.Annotations[kv[0]] = kv[1]
-	}
-	return ann, nil
-}
-
 // AddSignOptions adds the sign command options to cmd.
 func AddSignOptions(cmd *cobra.Command, o *SignOptions) {
 	cmd.Flags().StringVar(&o.Key, "key", "",
@@ -84,8 +64,7 @@ func AddSignOptions(cmd *cobra.Command, o *SignOptions) {
 	cmd.Flags().StringVar(&o.Attachment, "attachment", "",
 		"related image attachment to sign (sbom), default none")
 
-	cmd.Flags().StringSliceVarP(&o.Annotations, "annotations", "a", nil,
-		"extra key=value pairs to sign")
+	AddAnnotationOptions(cmd, &o.AnnotationOptions)
 
 	cmd.Flags().BoolVar(&o.RegistryOpts.AllowInsecure, "allow-insecure-registry", false,
 		"whether to allow insecure connections to registries. Don't use this for anything but testing")

cmd/cosign/main.go

@@ -50,7 +50,7 @@ func main() {
 	if len(os.Args) > 1 {
 		switch os.Args[1] {
 		case "public-key", "generate-key-pair",
-			"sign", "sign-blob",
+			"generate", "sign", "sign-blob",
 			"attest":
 			// cobra.
 		default: