-
Notifications
You must be signed in to change notification settings - Fork 49
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: use our own Statement type #930
Merged
Merged
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
63eee9f
sigstore: use our own Statement type
woodruffw f0c17ad
sigstore, test: make some APIs private
woodruffw eca82c6
dsse: typing accommodations for 3.8
woodruffw e1e1eb0
dsse: more 3.8 accommodations
woodruffw 02f2657
dsse: more 3.8 accommodations
woodruffw 01c137e
dsse: please stop
woodruffw deb4bad
CHANGELOG: record changes
woodruffw caae8b4
sigstore, test: fix logger visibility
woodruffw acd805d
sigstore: improve dsse APIs
woodruffw e79ea3a
CHANGELOG: tweak
woodruffw 0d9672a
Merge branch 'main' into ww/internal-statement
woodruffw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,184 @@ | ||
# Copyright 2022 The Sigstore Authors | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
""" | ||
Functionality for building and manipulating in-toto Statements and DSSE envelopes. | ||
""" | ||
|
||
from __future__ import annotations | ||
|
||
import logging | ||
from typing import Any, Literal, Union | ||
|
||
from cryptography.hazmat.primitives import hashes | ||
from cryptography.hazmat.primitives.asymmetric import ec | ||
from pydantic import BaseModel, ConfigDict, Field, RootModel, StrictStr, ValidationError | ||
from sigstore_protobuf_specs.io.intoto import Envelope, Signature | ||
|
||
logger = logging.getLogger(__name__) | ||
|
||
_Digest = Union[ | ||
Literal["sha256"], | ||
Literal["sha384"], | ||
Literal["sha512"], | ||
Literal["sha3_256"], | ||
Literal["sha3_384"], | ||
Literal["sha3_512"], | ||
] | ||
""" | ||
NOTE: in-toto's DigestSet contains all kinds of hash algorithms that | ||
we intentionally do not support. This model is limited to common members of the | ||
SHA-2 and SHA-3 family that are at least as strong as SHA-256. | ||
|
||
See: <https://github.com/in-toto/attestation/blob/main/spec/v1/digest_set.md> | ||
""" | ||
|
||
_DigestSet = RootModel[dict[_Digest, str]] | ||
""" | ||
An internal validation model for in-toto subject digest sets. | ||
""" | ||
|
||
|
||
class _Subject(BaseModel): | ||
""" | ||
A single in-toto statement subject. | ||
""" | ||
|
||
name: StrictStr | None | ||
digest: _DigestSet = Field(...) | ||
|
||
|
||
class _Statement(BaseModel): | ||
""" | ||
An internal validation model for in-toto statements. | ||
""" | ||
|
||
model_config = ConfigDict(populate_by_name=True) | ||
|
||
type_: Literal["https://in-toto.io/Statement/v1"] = Field(..., alias="_type") | ||
subjects: list[_Subject] = Field(..., min_length=1, alias="subject") | ||
predicate_type: StrictStr = Field(..., alias="predicateType") | ||
predicate: dict[str, Any] | None = Field(None, alias="predicate") | ||
|
||
|
||
class Statement: | ||
""" | ||
Represents an in-toto statement. | ||
|
||
This type deals with opaque bytes to ensure that the encoding does not | ||
change, but Statements are internally checked for conformance against | ||
the JSON object layout defined in the in-toto attesation spec. | ||
|
||
See: <https://github.com/in-toto/attestation/blob/main/spec/v1/statement.md> | ||
""" | ||
|
||
_ENVELOPE_TYPE = "application/vnd.in-toto+json" | ||
|
||
def __init__(self, contents: bytes) -> None: | ||
""" | ||
Construct a new Statement. | ||
|
||
This takes an opaque `bytes` containing the statement; use | ||
`StatementBuilder` to manually construct an in-toto statement | ||
from constituent pieces. | ||
""" | ||
self._contents = contents | ||
try: | ||
self._statement = _Statement.model_validate_json(contents) | ||
except ValidationError: | ||
raise ValueError("malformed in-toto statement") | ||
|
||
def _pae(self) -> bytes: | ||
""" | ||
Construct the PAE encoding for this statement. | ||
""" | ||
|
||
# See: | ||
# https://github.com/secure-systems-lab/dsse/blob/v1.0.0/envelope.md | ||
# https://github.com/in-toto/attestation/blob/v1.0/spec/v1.0/envelope.md | ||
pae = f"DSSEv1 {len(Statement._ENVELOPE_TYPE)} {Statement._ENVELOPE_TYPE} ".encode() | ||
pae += b" ".join([str(len(self._contents)).encode(), self._contents]) | ||
return pae | ||
|
||
def sign(self, key: ec.EllipticCurvePrivateKey) -> Envelope: | ||
""" | ||
Sign the statement, returning a DSSE envelope containing the statement's | ||
signature. | ||
""" | ||
|
||
pae = self._pae() | ||
logger.debug(f"DSSE PAE: {pae!r}") | ||
|
||
signature = key.sign(pae, ec.ECDSA(hashes.SHA256())) | ||
return Envelope( | ||
payload=self._contents, | ||
payload_type=Statement._ENVELOPE_TYPE, | ||
signatures=[Signature(sig=signature, keyid=None)], | ||
) | ||
|
||
|
||
class _StatementBuilder: | ||
""" | ||
A builder-style API for constructing in-toto Statements. | ||
""" | ||
|
||
def __init__( | ||
self, | ||
subjects: list[_Subject] | None = None, | ||
predicate_type: str | None = None, | ||
predicate: dict[str, Any] | None = None, | ||
): | ||
""" | ||
Create a new `_StatementBuilder`. | ||
""" | ||
self._subjects = subjects or [] | ||
self._predicate_type = predicate_type | ||
self._predicate = predicate | ||
|
||
def subjects(self, subjects: list[_Subject]) -> _StatementBuilder: | ||
""" | ||
Configure the subjects for this builder. | ||
""" | ||
self._subjects = subjects | ||
return self | ||
|
||
def predicate_type(self, predicate_type: str) -> _StatementBuilder: | ||
""" | ||
Configure the predicate type for this builder. | ||
""" | ||
self._predicate_type = predicate_type | ||
return self | ||
|
||
def predicate(self, predicate: dict[str, Any]) -> _StatementBuilder: | ||
""" | ||
Configure the predicate for this builder. | ||
""" | ||
self._predicate = predicate | ||
return self | ||
|
||
def build(self) -> Statement: | ||
""" | ||
Build a `Statement` from the builder's state. | ||
""" | ||
try: | ||
stmt = _Statement( | ||
type_="https://in-toto.io/Statement/v1", | ||
subjects=self._subjects, | ||
predicate_type=self._predicate_type, | ||
predicate=self._predicate, | ||
) | ||
except ValidationError as e: | ||
raise ValueError(f"invalid statement: {e}") | ||
|
||
return Statement(stmt.model_dump_json(by_alias=True).encode()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A consideration here: technically we make no canonical/serialization guarantees other than "it's valid JSON", but we could do RFC 8785 for good measure here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NB: We will probably want to make this API public at some point, but not yet (it needs more design consideration).