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, Spx: Add notes about metadata format stability #632

Merged
merged 4 commits into from
Sep 4, 2023

Conversation

jku
Copy link
Collaborator

@jku jku commented Sep 1, 2023

Both of these metadata formats (e.g. the data encoding and field names) are basically invented in securesystemslib: there is no community consensus on them yet.

I've also tweaked the sigstore docstring to be more exact

EDIT: I noticed SpxKey was part of the default key set: I'd rather err on the side of caution and not enable new keys automatically if we're not sure there is a consensus about the metadata format: I removed the key from default set

Both of these metadata formats (e.g. the data encoding and field names)
are bsaically invented in securesystemslib: there is no community
consensus on them yet.
The identity/issuer in the public key are the details that we verify
in the signing certificate. The OIDC identity of the authentication
token may be slightly different:
* because of identity federation the OIDC issuer may be sigstore.dev
  but the verified (federated) issuer may be github.com
* in the ambient credential case the authentication token identity
  does not necessarily match the sertificate identity

Make it clear that import_() takes the "verifying identity" details.
@jku jku mentioned this pull request Sep 1, 2023
@jku
Copy link
Collaborator Author

jku commented Sep 1, 2023

SpxKey is currently used by the default as well... as in a client will accept SPHINCS keys by default right now. I'm tempted to remove that so that it's comparable to SigstoreKey: both client and repository would explicitly have to enable SPHINCS for those keys to work.

Clients that want to enable SPHINCS keys can easily do that with
  KEY_FOR_TYPE_AND_SCHEME[("sphincs", "sphincs-shake-128s")]: SpxKey

This makes Spx and Sigstore behave similarly.
@jku
Copy link
Collaborator Author

jku commented Sep 1, 2023

I can't actually see who the maintainers are (GitHub is a bit silly in that) but I believe at least @adityasaky and @mnm678: could either of you review this?

this is preparation for #631

@adityasaky adityasaky self-requested a review September 1, 2023 14:03
No need to talk about TUF specification here: the point is
that we're not sure if the key formats are final and have community
consensus yet -- wherever that may form.
Copy link
Member

@adityasaky adityasaky left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@jku jku merged commit 819e5a1 into secure-systems-lab:main Sep 4, 2023
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.

3 participants