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

Externalize API or library for writing/parsing Sigstore bundles #1132

Open
di opened this issue Sep 18, 2024 · 1 comment
Open

Externalize API or library for writing/parsing Sigstore bundles #1132

di opened this issue Sep 18, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@di
Copy link
Member

di commented Sep 18, 2024

Description

Currently this project publicly provides models.Bundle which supports to_json and from_json, but does not expose a lower-level API to create/modify specific fields of the Sigstore bundle, read/write the bundle to/from a file, etc. This makes it challenging to use the Sigstore bundle format from within other Python libraries/applications, including use cases that include non-signing bundle operations, PKI based signing, etc.

Desired outcome

Either:

  • expand the public API of sigstore-python to include a lower-level API to create/modify a Sigstore bundle
  • break out the relevant functionality into a separate sigstore-bundle library with a public API that this project can consume as a sub-dependency

(cc @haydentherapper @mihaimaruseac @woodruffw)

@di di added the enhancement New feature or request label Sep 18, 2024
@woodruffw
Copy link
Member

I'm a big fan of this idea! My personal preference is for option 2: IMO it'd be ideal to have this in a sigstore-models (or similar) library that both sigstore-python and anything else that needs direct model access at the API level can use.

Having it be in a separate library also aligns closely with #1049 -- a "pure" models API could be done with just pydantic, which would both make the models API more Pythonic and eliminate a complexifying dependency (betterproto) of ours.

@woodruffw woodruffw self-assigned this Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants