8000 Port gitsign-attest to cobra subcommand. by wlynch · Pull Request #195 · sigstore/gitsign · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Port gitsign-attest to cobra subcommand. #195

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.

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

Merged
merged 1 commit into from
Nov 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
85 changes: 0 additions & 85 deletions cmd/gitsign-attest/main.go

This file was deleted.

3 changes: 2 additions & 1 deletion docs/cli/gitsign.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ gitsign [flags]

### SEE ALSO

* [gitsign attest](gitsign_attest.md) - add attestations to Git objects
* [gitsign show](gitsign_show.md) - Show source predicate information
* [gitsign version](gitsign_version.md) - print Gitsign version

###### Auto generated by spf13/cobra on 21-Nov-2022
###### Auto generated by spf13/cobra on 26-Nov-2022
22 changes: 22 additions & 0 deletions docs/cli/gitsign_attest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## gitsign attest

add attestations to Git objects

```
gitsign attest [flags]
```

### Options

```
-f, --filepath string attestation filepath
-h, --help help for attest
--objtype string [commit | tree] - Git object type to attest (default "commit")
--type string specify a predicate type (slsaprovenance|link|spdx|spdxjson|cyclonedx|vuln|custom) or an URI (default "custom")
```

### SEE ALSO

* [gitsign](gitsign.md) - Keyless Git signing with Sigstore!

###### Auto generated by spf13/cobra on 26-Nov-2022
2 changes: 1 addition & 1 deletion docs/cli/gitsign_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ gitsign show [revision] [flags]

* [gitsign](gitsign.md) - Keyless Git signing with Sigstore!

###### Auto generated by spf13/cobra on 21-Nov-2022
###### Auto generated by spf13/cobra on 26-Nov-2022
2 changes: 1 addition & 1 deletion docs/cli/gitsign_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ gitsign version [flags]

* [gitsign](gitsign.md) - Keyless Git signing with Sigstore!

###### Auto generated by spf13/cobra on 21-Nov-2022
###### Auto generated by spf13/cobra on 26-Nov-2022
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ f44de7a (HEAD -> main) commit
2b0ff1e commit 1
760568f initial commit
$ gitsign-attest -f test.json
$ gitsign-attest -f spdx.sbom -type spdx
$ gitsign-attest -f spdx.sbom --type spdx
$ git checkout refs/attestations/commits
$ tree
.
Expand All @@ -51,7 +51,7 @@ preserve attestations for squash commits, or between sub-directories.
```sh
$ git log --oneline --format="Commit: %h Tree: %t" -1
Commit: edd19d9 Tree: 853a6ca
$ gitsign-attest -f test.json -t
$ gitsign-attest -f test.json --objtype tree
$ git checkout refs/attestations/trees
$ tree .
.
Expand Down
114 changes: 114 additions & 0 deletions internal/commands/attest/attest.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
// Copyright 2022 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 attest

import (
"context"
"fmt"

"github.com/go-git/go-git/v5"
cosignopts "github.com/sigstore/cosign/cmd/cosign/cli/options"
"github.com/sigstore/cosign/cmd/cosign/cli/sign"
"github.com/sigstore/cosign/pkg/cosign"
"github.com/sigstore/gitsign/internal/attest"
"github.com/sigstore/gitsign/internal/config"
"github.com/spf13/cobra"
)

const (
attCommitRef = "refs/attestations/commits"
attTreeRef = "refs/attestations/trees"

FlagObjectTypeCommit = "commit"
FlagObjectTypeTree = "tree"
)

type options struct {
Config *config.Config

FlagObjectType string
FlagPath string
FlagAttestationType string
}

func (o *options) AddFlags(cmd *cobra.Command) {
cmd.Flags().StringVar(&o.FlagObjectType, "objtype", FlagObjectTypeCommit, "[commit | tree] - Git object type to attest")
cmd.Flags().StringVarP(&o.FlagPath, "filepath", "f", "", "attestation filepath")
cmd.Flags().StringVar(&o.FlagAttestationType, "type", "", `specify a predicate type (slsaprovenance|link|spdx|spdxjson|cyclonedx|vuln|custom) or an URI (default "custom")`)
}

func (o *options) Run(ctx context.Context) error {
repo, err := git.PlainOpen(".")
if err != nil {
return fmt.Errorf("error opening repo: %w", err)
}

head, err := repo.Head()
if err != nil {
return fmt.Errorf("error getting repository head: %w", err)
}

// If we're attaching the attestation to a tree, resolve the tree SHA.
sha := head.Hash()
refName := attCommitRef
if o.FlagObjectType == FlagObjectTypeTree {
commit, err := repo.CommitObject(head.Hash())
if err != nil {
return fmt.Errorf("error getting tree: %w", err)
}
sha = commit.TreeHash

refName = attTreeRef
}

sv, err := sign.SignerFromKeyOpts(ctx, "", "", cosignopts.KeyOpts{
FulcioURL: o.Config.Fulcio,
RekorURL: o.Config.Rekor,
OIDCIssuer: o.Config.Issuer,
OIDCClientID: o.Config.ClientID,
})
if err != nil {
return fmt.Errorf("getting signer: %w", err)
}
defer sv.Close()

attestor := attest.NewAttestor(repo, sv, cosign.TLogUploadInTotoAttestation)

out, err := attestor.WriteFile(ctx, refName, sha, o.FlagPath, o.FlagAttestationType)
if err != nil {
return err
}
fmt.Println(out)

return nil
}

func New(cfg *config.Config) *cobra.Command {
o := &options{
Config: cfg,
}
cmd := &cobra.Command{
Use: "attest",
Short: "add attestations to Git objects",
Args: cobra.ArbitraryArgs,
RunE: func(cmd *cobra.Command, args []string) error {
ctx := context.Background()
return o.Run(ctx)
},
}
o.AddFlags(cmd)

return cmd
}
2 changes: 2 additions & 0 deletions internal/commands/root/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package root
import (
"github.com/spf13/cobra"

"github.com/sigstore/gitsign/internal/commands/attest"
"github.com/sigstore/gitsign/internal/commands/show"
"github.com/sigstore/gitsign/internal/commands/version"
"github.com/sigstore/gitsign/internal/config"
Expand Down Expand Up @@ -82,6 +83,7 @@ func New(cfg *config.Config) *cobra.Command {

rootCmd.AddCommand(version.New(cfg))
rootCmd.AddCommand(show.New(cfg))
rootCmd.AddCommand(attest.New(cfg))
o.AddFlags(rootCmd)

return rootCmd
Expand Down
0