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

Create bundle.md #341

Merged
merged 2 commits into from
Nov 1, 2024
Merged

Create bundle.md #341

merged 2 commits into from
Nov 1, 2024

Conversation

loosebazooka
Copy link
Member

A human readable bundle specification, specifically for the public good instances

I'm not sure doing only public good is idea, but I think it removes some of the other more confusing things from the spec.

The included github attestation example is from conformance -- maybe there's a better real world example somewhere?

Copy link

netlify bot commented Oct 29, 2024

Deploy Preview for docssigstore ready!

Name Link
🔨 Latest commit ceedd0a
🔍 Latest deploy log https://app.netlify.com/sites/docssigstore/deploys/6724eabba777d100085a47a9
😎 Deploy Preview https://deploy-preview-341--docssigstore.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

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

This is great!

Do you think we should discuss what to do with a bundle at all, touching on the verification aspect, e.g. needing to verify identities, meet thresholds?

content/en/about/bundle.md Outdated Show resolved Hide resolved
content/en/about/bundle.md Show resolved Hide resolved
content/en/about/bundle.md Outdated Show resolved Hide resolved
content/en/about/bundle.md Outdated Show resolved Hide resolved
content/en/about/bundle.md Outdated Show resolved Hide resolved
content/en/about/bundle.md Outdated Show resolved Hide resolved
Copy link
Member Author

@loosebazooka loosebazooka left a comment

Choose a reason for hiding this comment

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

moved signing time to "Verification Material" section.

content/en/about/bundle.md Show resolved Hide resolved
content/en/about/bundle.md Outdated Show resolved Hide resolved
content/en/about/bundle.md Outdated Show resolved Hide resolved
Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

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

Thanks, this is great!

A human readable bundle specification, specifically for the public good instances

Co-authored-by: Hayden B <[email protected]>
Signed-off-by: Appu <[email protected]>
@loosebazooka
Copy link
Member Author

fixed some formatting things

Copy link
Member

@kommendorkapten kommendorkapten left a comment

Choose a reason for hiding this comment

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

Awesome!

@haydentherapper
Copy link
Contributor

Will let @steiza review, then I’ll merge

Copy link
Member

@steiza steiza left a comment

Choose a reason for hiding this comment

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

One minor non-blocking comment (EDIT: otherwise looks great, thanks for putting this together!)


#### Transparency Log Entries

One or more transparency logs entries to provide proof of inclusion in a public log and optionally a timestamp to
Copy link
Member

Choose a reason for hiding this comment

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

Minor: a transparency log entry isn't required for a bundle, should we say "Zero or more..." like we do below for Timestamps?

We already say above:

bundles must include at least one transparency log's signed entry timestamp or an RFC3161 timestamp

Copy link
Member Author

@loosebazooka loosebazooka Nov 1, 2024

Choose a reason for hiding this comment

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

Oh I always thought a log entry was required but you don't have to trust the log's clock (so you can ignore the SET and use the rfc3161 timestamp). Maybe requiring a log entry is only true for the public usecase?

Copy link
Contributor

Choose a reason for hiding this comment

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

Log entries are not required - https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto#L105

I think we should word it that it is expected that bundles contain log entries for public consumption.

Copy link
Member Author

Choose a reason for hiding this comment

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

updated this section a bit

Signed-off-by: Appu Goundan <[email protected]>
@haydentherapper haydentherapper merged commit c6fa9ea into sigstore:main Nov 1, 2024
6 checks passed
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

Successfully merging this pull request may close these issues.

4 participants