-
Notifications
You must be signed in to change notification settings - Fork 96
Update cosign docs on new bundle format #385
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
base: main
Are you sure you want to change the base?
Update cosign docs on new bundle format #385
Conversation
❌ Deploy Preview for docssigstore failed.
|
Signed-off-by: Cody Soyland <codysoyland@github.com>
d15415a to
ab7a96d
Compare
Signed-off-by: Cody Soyland <codysoyland@github.com>
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.
nit on JS typecasing
The signature suffix (`.sigstore`) is subject to change. This is so new, there is no documentation yet. Existing documentation and its pending update do not mention or specify a suffix (or I couldn't find it.) An internet or GitHub search also didn't help. I've seen so far: .sigstore.json, .bundle, .sig TODO: also update this in curl/curl-www once decided or before the next release latest. It's also an option to stay with the `.cosign` suffix and format, though not recommended. Ref: sigstore/cosign#4440 Ref: sigstore/sigstore-blog#89 Ref: sigstore/docs#385
The suffix is entirely arbitrary on my part. I could find no mention of what this should be, and it's also brand new, with no clear practice or convention I could find. Anyway, the content of the .sigstore file is the "new bundle" format, which allows offline verification. It has been released in full last month by cosign and made the default in yesterday's release (3.0.1). It's also the officially recommanded format. This was preceded by a slipped out 3.0.0 release 2 days ago, triggering a quick fix downstream in curl-for-win. Ref: curl/curl-for-win@aaf54db Docs page not yet updated: https://docs.sigstore.dev/about/bundle/ Pending PR: sigstore/docs#385 Neither says mentions a filename convention.
The suffix is entirely arbitrary on my part. I could find no mention of what this should be, and it's also brand new, with no clear practice or convention I could find. Anyway, the content of the .sigstore file is the "new bundle" format, which allows offline verification. It has been released in full last month by cosign and made the default in yesterday's release (3.0.1). It's also the officially recommanded format. This was preceded by a slipped out 3.0.0 release 2 days ago, triggering a quick fix downstream in curl-for-win. Ref: curl/curl-for-win@aaf54db Docs page not yet updated: https://docs.sigstore.dev/about/bundle/ Pending PR: sigstore/docs#385 Neither mentions a filename convention.
…mat) (#494) The suffix is entirely arbitrary on my part. I could find no mention of what this should be, and it's also brand new, with no clear practice or convention I could find. Anyway, the content of the `.sigstore` file is the "new bundle" format, which allows offline verification. It has been released in full last month by cosign and made the default in yesterday's release (3.0.1). It's also the officially recommanded format. This was preceded by a slipped out 3.0.0 release 2 days ago, triggering a quick fix downstream in curl-for-win. Ref: curl/curl-for-win@aaf54db Docs page not yet updated: https://docs.sigstore.dev/about/bundle/ Pending PR: sigstore/docs#385
|
Is there a standard or recommended filename suffix for a new bundle signature? (as was |
Signed-off-by: ltagliaferri <lisa.tagliaferri@gmail.com>
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.
Hold on merging, this is now out of date given Cosign v3
Summary
Adding a bit more detail to the Cosign bundle format section.
Release Note
Documentation