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.

Sign up for GitHub

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
Merged

Sigstore, Spx: Add notes about metadata format stability #632

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b34803
Sigstore, Spx: Add notes about metadata format stability
jku Sep 1, 2023
e7f7c89
Sigstore: improve docstring language
jku Sep 1, 2023
936bc04
Spx: Make SpxKey not part of default keyset
jku Sep 1, 2023
f2a39f5
Sigstore, Spx: Improve docstring phrasing
jku Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions securesystemslib/signer/_sigstore_signer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@
class SigstoreKey(Key):
"""Sigstore verifier.

NOTE: unstable API - routines and metadata formats may change!
NOTE: The Sigstore key and signature metadata formats are not part of the
TUF specification and are not considered stable in securesystemslib. They
jku marked this conversation as resolved.
Show resolved Hide resolved
may change in future releases and may not be supported by other
implementations.
"""

DEFAULT_KEY_TYPE = "sigstore-oidc"
Expand Down Expand Up @@ -87,7 +90,10 @@ def verify_signature(self, signature: Signature, data: bytes) -> None:
class SigstoreSigner(Signer):
"""Sigstore signer.

NOTE: unstable API - routines and metadata formats may change!
NOTE: The Sigstore key and signature metadata formats are not part of the
TUF specification and are not considered stable in securesystemslib. They
may change in future releases and may not be supported by other
implementations.

All signers should be instantiated with ``Signer.from_priv_key_uri()``.
Unstable ``SigstoreSigner`` currently requires opt-in via
Expand Down Expand Up @@ -183,8 +189,8 @@ def import_(
key should be stored for later use.

Arguments:
identity: The OIDC identity used to create a signing token.
issuer: The OIDC issuer URL used to create a signing token.
identity: The OIDC identity to use when verifying a signature.
issuer: The OIDC issuer to use when verifying a signature.
ambient: Toggle usage of ambient credentials in returned URI.
"""
keytype = SigstoreKey.DEFAULT_KEY_TYPE
Expand Down
13 changes: 12 additions & 1 deletion securesystemslib/signer/_spx_signer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ def generate_spx_key_pair() -> Tuple[bytes, bytes]:


class SpxKey(Key):
"""SPHINCS+ verifier."""
"""SPHINCS+ verifier.

NOTE: The SPHINCS+ key and signature metadata formats are not part of the
TUF specification and are not considered stable in securesystemslib. They
may change in future releases and may not be supported by other
implementations.
"""

DEFAULT_KEY_TYPE = "sphincs"
DEFAULT_SCHEME = "sphincs-shake-128s"
Expand Down Expand Up @@ -89,6 +95,11 @@ def verify_signature(self, signature: Signature, data: bytes) -> None:
class SpxSigner(Signer):
"""SPHINCS+ signer.

NOTE: The SPHINCS+ key and signature metadata formats are not part of the
TUF specification and are not considered stable in securesystemslib. They
may change in future releases and may not be supported by other
implementations.

Usage::

public_bytes, private_bytes = generate_spx_key_pair()
Expand Down