Fix piv-tool generate-key command in TOKENS doc #1850
Merged
Conversation
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
dlorenc
previously approved these changes
May 6, 2022
|
I also found and fixed a mistake in the |
cpanato
reviewed
May 7, 2022
TOKENS.md
Outdated
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| The `cosign` command line tool optionally supports hardware tokens for signing and key management. | |||
| This support is enabled through the [PIV protocol](https://csrc.nist.gov/projects/piv/piv-standards-and-supporting-documentation) | |||
| and the [go-piv](https://github.com/go-piv/piv-go) library, which is not included in the standard release. Use [`make cosign-pivkey`](https://github.com/sigstore/cosign/blob/a8d1cc1132d4a019a62ff515b9375c8c5b98a5c5/Makefile#L52), or `go build -tags=pivkey`, to build `cosign` with support for hardware tokens. | |||
| and the [go-piv](https://github.com/go-piv/piv-go) library, which is not included in the standard release. Use `make cosign-pivkey-pkcs11key`, or `cd cmd/cosign; go build -tags=pivkey`, to build `cosign` with support for hardware tokens. | |||
There was a problem hiding this comment.
instead of the cd cmd/cosign would use
go build -tags=pivkey,pkcs11key -o cosign ./cmd/cosign
There was a problem hiding this comment.
Very nice. Done, though I left out the -o cosign which seems optional. Make sense?
[cosign/TOKENS\.md at main · sigstore/cosign](https://github.com/sigstore/cosign/blob/main/TOKENS.md) says: ... *run the* `cosign generate-key` *command* ... Which yields this error: ``` $ cosign generate-key Error: unknown command "generate-key" for "cosign" ``` The documentation is simply missing the `piv-tool` sub-command. Resolves: sigstore#1849 Also fix make target for custom build: was make cosign-pivkey now make cosign-pivkey-pkcs11key. Drop old, brittle reference to line in Makefile. Also make `go build` also work the same way, from the root directory. See also: sigstore#1853 Signed-off-by: Neal McBurnett <neal@mcburnett.org>
dlorenc
approved these changes
May 7, 2022
pxp928
pushed a commit
to pxp928/cosign
that referenced
this pull request
May 12, 2022
[cosign/TOKENS\.md at main · sigstore/cosign](https://github.com/sigstore/cosign/blob/main/TOKENS.md) says: ... *run the* `cosign generate-key` *command* ... Which yields this error: ``` $ cosign generate-key Error: unknown command "generate-key" for "cosign" ``` The documentation is simply missing the `piv-tool` sub-command. Resolves: sigstore#1849 Also fix make target for custom build: was make cosign-pivkey now make cosign-pivkey-pkcs11key. Drop old, brittle reference to line in Makefile. Also make `go build` also work the same way, from the root directory. See also: sigstore#1853 Signed-off-by: Neal McBurnett <neal@mcburnett.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
cosign/TOKENS.md at main · sigstore/cosign says:
... run the
cosign generate-keycommand ...Which yields this error:
The documentation is simply missing the
piv-toolsub-command.Ticket Link
Resolves: #1849
Signed-off-by: Neal McBurnett neal@mcburnett.org
Release Note