Skip to content
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.

Sign up for GitHub

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

fix: shell completion improvements #831

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: shell completion improvements #831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e53e42b
fix: args in verify-vsa usage message
scop Feb 11, 2025
3b689f7
fix: do not offer shell filename completions when they are not expected
scop Feb 11, 2025
d7880e2
fix: filter shell filename completions to appropriate extensions
scop Feb 11, 2025
c1d66c9
Merge branch 'main' into fix/shell-completions
ramonpetgrave64 Feb 14, 2025
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
17 changes: 13 additions & 4 deletions cli/slsa-verifier/verify.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ func verifyArtifactCmd() *cobra.Command {
o.AddFlags(cmd)
// --provenance-path must be supplied when verifying an artifact.
cmd.MarkFlagRequired("provenance-path")
cmd.MarkFlagFilename("provenance-path", verify.CommonAttestationFilenameExtensions...)
return cmd
}

Expand All @@ -86,7 +87,8 @@ func verifyImageCmd() *cobra.Command {
}
return nil
},
Short: "Verifies SLSA provenance on a container image",
ValidArgsFunction: cobra.NoFileCompletions,
Short: "Verifies SLSA provenance on a container image",
Run: func(cmd *cobra.Command, args []string) {
v := verify.VerifyImageCommand{
SourceURI: o.SourceURI,
Expand Down Expand Up @@ -136,6 +138,12 @@ func verifyNpmPackageCmd() *cobra.Command {
}
return nil
},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
if len(args) != 0 {
return nil, cobra.ShellCompDirectiveNoFileComp
}
Comment on lines +142 to +144
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works like a shortcut to say that all of options shouldn't offer completion?

Copy link
Contributor Author

@scop scop Feb 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It means that if we already have one or more positional argument, do not offer any more as completions, as verify-npm-package takes only one positional argument.

return []string{"tgz"}, cobra.ShellCompDirectiveFilterFileExt
},
Short: "Verifies SLSA provenance for an npm package tarball [experimental]",
Run: func(cmd *cobra.Command, args []string) {
v := verify.VerifyNpmPackageCommand{
Expand Down Expand Up @@ -189,9 +197,10 @@ func verifyVSACmd() *cobra.Command {
o := &verify.VerifyVSAOptions{}

cmd := &cobra.Command{
Use: "verify-vsa [flags] subject-digest [subject-digest...]",
Args: cobra.NoArgs,
Short: "Verifies SLSA VSAs for the given subject-digests",
Use: "verify-vsa [flags]",
Args: cobra.NoArgs,
ValidArgsFunction: cobra.NoFileCompletions,
Short: "Verifies SLSA VSAs for the given subject-digests",
Run: func(cmd *cobra.Command, args []string) {
v := verify.VerifyVSACommand{
SubjectDigests: &o.SubjectDigests,
Expand Down
26 changes: 26 additions & 0 deletions cli/slsa-verifier/verify/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,31 +45,41 @@ type VerifyOptions struct {

var _ Interface = (*VerifyOptions)(nil)

var CommonAttestationFilenameExtensions = []string{"sigstore", "intoto", "intoto.jsonl", "json"}

// AddFlags implements Interface.
func (o *VerifyOptions) AddFlags(cmd *cobra.Command) {
/* Builder options */
cmd.Flags().Var(&o.BuildWorkflowInputs, "build-workflow-input",
"[optional] a workflow input provided by a user at trigger time in the format 'key=value'. (Only for 'workflow_dispatch' events on GitHub Actions).")
cmd.RegisterFlagCompletionFunc("build-workflow-input", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.BuilderID, "builder-id", "", "[optional] the unique builder ID who created the provenance")
cmd.RegisterFlagCompletionFunc("builder-id", cobra.NoFileCompletions)

/* Source options */
cmd.Flags().StringVar(&o.SourceURI, "source-uri", "",
"expected source repository that should have produced the binary, e.g. github.com/some/repo")
cmd.RegisterFlagCompletionFunc("source-uri", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.SourceBranch, "source-branch", "", "[optional] expected branch the binary was compiled from")
cmd.RegisterFlagCompletionFunc("source-branch", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.SourceTag, "source-tag", "", "[optional] expected tag the binary was compiled from")
cmd.RegisterFlagCompletionFunc("source-tag", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.SourceVersionTag, "source-versioned-tag", "",
"[optional] expected version the binary was compiled from. Uses semantic version to match the tag")
cmd.RegisterFlagCompletionFunc("source-versioned-tag", cobra.NoFileCompletions)

/* Other options */
cmd.Flags().StringVar(&o.ProvenancePath, "provenance-path", "",
"path to a provenance file")
cmd.MarkFlagFilename("provenance-path", CommonAttestationFilenameExtensions...)

cmd.Flags().StringVar(&o.ProvenanceRepository, "provenance-repository", "",
"image repository for provenance with format: <registry>/<repository>")
cmd.RegisterFlagCompletionFunc("provenance-repository", cobra.NoFileCompletions)

cmd.Flags().BoolVar(&o.PrintProvenance, "print-provenance", false,
"[optional] print the verified provenance to stdout")
Expand All @@ -94,28 +104,37 @@ func (o *VerifyNpmOptions) AddFlags(cmd *cobra.Command) {
/* Builder options */
cmd.Flags().Var(&o.BuildWorkflowInputs, "build-workflow-input",
"[optional] a workflow input provided by a user at trigger time in the format 'key=value'. (Only for 'workflow_dispatch' events on GitHub Actions).")
cmd.RegisterFlagCompletionFunc("build-workflow-input", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.BuilderID, "builder-id", "", "[optional] the unique builder ID who created the provenance")
cmd.RegisterFlagCompletionFunc("builder-id", cobra.NoFileCompletions)

/* Source options */
cmd.Flags().StringVar(&o.SourceURI, "source-uri", "",
"expected source repository that should have produced the binary, e.g. github.com/some/repo")
cmd.RegisterFlagCompletionFunc("source-uri", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.SourceBranch, "source-branch", "", "[optional] expected branch the binary was compiled from")
cmd.RegisterFlagCompletionFunc("source-branch", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.SourceTag, "source-tag", "", "[optional] expected tag the binary was compiled from")
cmd.RegisterFlagCompletionFunc("source-tag", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.SourceVersionTag, "source-versioned-tag", "",
"[optional] expected version the binary was compiled from. Uses semantic version to match the tag")
cmd.RegisterFlagCompletionFunc("source-versioned-tag", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.AttestationsPath, "attestations-path", "",
"path to a file containing the attestations")
cmd.MarkFlagFilename("attestations-path", CommonAttestationFilenameExtensions...)

cmd.Flags().StringVar(&o.PackageName, "package-name", "",
"the package name")
cmd.RegisterFlagCompletionFunc("package-name", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.PackageVersion, "package-version", "",
"the package version")
cmd.RegisterFlagCompletionFunc("package-version", cobra.NoFileCompletions)

cmd.Flags().BoolVar(&o.PrintProvenance, "print-provenance", false,
"[optional] print the verified provenance to stdout")
Expand Down Expand Up @@ -145,27 +164,34 @@ var _ Interface = (*VerifyVSAOptions)(nil)
func (o *VerifyVSAOptions) AddFlags(cmd *cobra.Command) {
cmd.Flags().StringArrayVar(&o.SubjectDigests, "subject-digest", []string{},
"the digests to be verified. Pass multiple digests by repeating the flag. e.g. --subject-digest <digest type>:<digest value> --subject-digest <digest type>:<digest value>")
cmd.RegisterFlagCompletionFunc("subject-digest", cobra.NoFileCompletions)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't add this line, would the behavior be the same?

Copy link
Contributor Author

@scop scop Feb 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No; without it, all filenames in the current dir will be suggested as arguments for the flag.


cmd.Flags().StringVar(&o.AttestationPath, "attestation-path", "",
"path to a file containing the attestation")
cmd.MarkFlagFilename("attestation-path", CommonAttestationFilenameExtensions...)

cmd.Flags().StringVar(&o.VerifierID, "verifier-id", "",
"the unique verifier ID who created the attestation")
cmd.RegisterFlagCompletionFunc("verfier-id", cobra.NoFileCompletions)

cmd.Flags().StringVar(&o.ResourceURI, "resource-uri", "",
"the resource URI to be verified")
cmd.RegisterFlagCompletionFunc("resource-uri", cobra.NoFileCompletions)

cmd.Flags().StringArrayVar(&o.VerifiedLevels, "verified-level", []string{},
"[optional] the levels of verification to be performed. Pass multiple digests by repeating the flag, e.g., --verified-level SLSA_BUILD_LEVEL_2 --verified-level FEDRAMP_LOW'")
cmd.RegisterFlagCompletionFunc("verified-level", cobra.NoFileCompletions)

cmd.Flags().BoolVar(&o.PrintAttestation, "print-attestation", false,
"[optional] print the contents of attestation to stdout")

cmd.Flags().StringVar(&o.PublicKeyPath, "public-key-path", "",
"path to a public key file")
cmd.MarkFlagFilename("public-key-path", "pem")

cmd.Flags().StringVar(&o.PublicKeyID, "public-key-id", "",
"[optional] the ID of the public key, defaults to the SHA256 digest of the base64-encoded public key")
cmd.RegisterFlagCompletionFunc("public-key-id", cobra.NoFileCompletions)

cmd.MarkFlagRequired("subject-digests")
cmd.MarkFlagRequired("attestation-path")
Expand Down
Loading