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
Document Staging instance usage with Keyless #1824
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -116,6 +116,43 @@ Signature timestamps are checked in the [rekor](https://github.com/sigstore/reko | |
* Probably a lot more: This is very experimental. | ||
* More OIDC providers: Obvious. | ||
|
||
## Public Staging Environment | ||
|
||
|
||
There is a public staging environment that is running Fulcio, Rekor and OIDC issuer. | ||
|
||
**NOTE** The staging environment provides no SLO guarantees nor the same protection of the root key material for TUF. This environment is meant for development and testing only, PLEASE do not use for production purposes. | ||
|
||
The endpoints are as follows: | ||
|
||
* https://fulcio.sigstage.dev | ||
* https://rekor.sigstage.dev | ||
* https://oauth2.sigstage.dev/auth | ||
|
||
These instances are operated and maintained in the same manner as the public production environment for Sigstore. | ||
|
||
### Usage | ||
|
||
To use this instance, follow the steps below: | ||
|
||
1. `rm -r ~/.sigstore` | ||
1. `gsutil cp -r gs://tuf-root-staging/root.json .` | ||
1. `cd tuf-root-staging` | ||
1. `cosign initialize --mirror=tuf-root-staging --root=root.json` | ||
1. `COSIGN_EXPERIMENTAL=1 cosign sign --oidc-issuer "https://oauth2.sigstage.dev/auth" --fulcio-url "https://fulcio.sigstage.dev" --rekor-url "https://rekor.sigstage.dev" ${IMAGE}` | ||
1. `COSIGN_EXPERIMENTAL=1 cosign verify --rekor-url "https://rekor.sigstage.dev" ${IMAGE}` | ||
|
||
* Steps 1-4 configures your local environment to use the staging keys and certificates. | ||
* Step 5 specify the staging environment with flags needed for signing. | ||
* Step 6 specify the staging environment with flags needed for verifying. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we also note how to get back to using production, rm the Sigstore directory and init? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good point. |
||
#### Revert back to Production | ||
|
||
We need to clear the local TUF root data and re-initialize with the default production TUF root data. | ||
|
||
1. `rm -r ~/.sigstore` | ||
1. `cosign initialize` | ||
|
||
## Custom Infrastructure | ||
|
||
If you're running your own sigstore services flags are available to set your own endpoint's, e.g | ||
|
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.
There will be no SLO provided nor the same protection of the root key material for TUF. We should loudly note this, that this is staging and never should be used for production.
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.
added note about slo and not for production use.