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.

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

Sigstore documentation doesn't have example for .sigstore bundles #2285

Closed
sethmlarson opened this issue Jun 22, 2023 · 7 comments
Closed

Sigstore documentation doesn't have example for .sigstore bundles #2285

sethmlarson opened this issue Jun 22, 2023 · 7 comments

Comments

@sethmlarson
Copy link
Contributor

Describe the bug

Follow-up from #2247, the examples on the Sigstore information page (https://python.org/download/sigstore) only references being able to verify .crt and .sig files, where now new releases have a singular Sigstore bundle file .sigstore that should be verified with --bundle <FILE>.

Since there are releases out there with both flavors of verification material, we'll need to give the user instructions on which method to use based on which materials are available.

I was going to make the contribution to fix this myself, but I was unable to grep the Sigstore Information page header anywhere in this project or under the python org in GitHub. Maybe my search skills or GitHub is failing here somehow, but where is the source code for the page in question?

@woodruffw
Copy link

Thanks for pinging me downstream! Adding an example of verifying using --bundle seems exactly appropriate to me.

Maybe my search skills or GitHub is failing here somehow, but where is the source code for the page in question?

I think I ran into the same thing -- I believe it's in a CMS somewhere, and @di has modified it in the past.

@di
Copy link
Member

di commented Jun 23, 2023

It is indeed in the python.org CMS, which I have edit access to.

@ned-deily
Copy link
Member

There probably should also be refereences to sigstore on the Python Downloads page. I've opened a new issue about that.

@sethmlarson
Copy link
Contributor Author

As a part of this work I'd like to backfill the existing crt/sig files with bundles for easier verification instructions. @woodruffw and I created this issue to track this functionality in sigstore-python: sigstore/sigstore-python#718

@sethmlarson
Copy link
Contributor Author

Created a task for back-filling Python releases from existing verification materials: #2300

@sethmlarson
Copy link
Contributor Author

sethmlarson commented Sep 12, 2023

Once bundles have been backfilled and the documentation updated we can remove the crt/sig generation from python/release-tools to match the default generation behavior from sigstore-python v2.

@sethmlarson
Copy link
Contributor Author

Releases have been backfilled with bundles so I've updated the documentation to only reference verifying Sigstore bundles. We can now close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants