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

Need better clarity on bundle filename for chains of attestations #107

Closed
MarkLodato opened this issue Sep 16, 2022 · 5 comments · Fixed by #115
Closed

Need better clarity on bundle filename for chains of attestations #107

MarkLodato opened this issue Sep 16, 2022 · 5 comments · Fixed by #115

Comments

@MarkLodato
Copy link
Contributor

The current bundle file naming convention is misleading for the case when the bundle is a set of dependent attestations that are all "about" a single artifact but have different subjects. Current wording:

  • Bundles that concern a single artifact SHOULD name the bundle file <artifact filename>.intoto.jsonl.
  • Bundles that concern multiple artifacts SHOULD name the bundle file multiple.intoto.jsonl.

The phrase "concern a single artifact" needs more specificity. It could be read two ways:

  • (unintended) If any of the attestations in the bundle have a subject other than <artifact>, name it multiple.intoto.jsonl.
  • (intended) If the set of attestations are intended to verify a single artifact, regardless of the attestations' subject, name it <artifact filename>.intoto.jsonl.

cc: @shaunmlowry @TomHennen @mlieberman85

@TomHennen
Copy link
Contributor

Yes, agreed.

(intended) If the set of attestations are intended to verify a single artifact, regardless of the attestations' subject, name it .intoto.jsonl.

I wonder if this should cover "attestations produced during the artifact's SDLC"?

@mlieberman85
Copy link

Here's how I see it potentially playing out. I am OK with duplicating an attestation across for multiple artifacts if that one attestation has multiple subjects. Since we have jsonl we can do stuff like:

Attestation A refers to Artifact 1 and Artifact 2.
Attestation B refers only to Artifact 1.
Attestation C refers only to Artifact 2.

artifact1.jsonl can contain Attestation A and Attestation B.
artifact2.jsonl can contain Attestation A and Attestation C.

Just want to clarify there that however we word it, it should support the above use case.

@TomHennen
Copy link
Contributor

I agree with that.

I think it would also be fine if artifact1.jsonl contained Attestation A, B, and C.

I.e. it's fine (but not optimal) if the bundle contains attestations that aren't applicable.

@laurentsimon
Copy link

laurentsimon commented Sep 26, 2022

feedback from sigstore/sigstore-python#223 (comment): need the version number in the filename, multiple-v1.2.3.intoto.jsonl. /cc @diogoteles08

@MarkLodato
Copy link
Contributor Author

Please see #115 for a potential fix.

marcelamelara added a commit that referenced this issue Oct 25, 2022
Clarify bundle naming convention

Fixes #107
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 a pull request may close this issue.

4 participants