From b07be9b3781e90d9d10857087d4097c5b33dc920 Mon Sep 17 00:00:00 2001 From: William Woodruff Date: Tue, 10 Jan 2023 17:24:51 -0500 Subject: [PATCH] sigstore: `RekorEntryMissing` -> `LogEntryMissing` (#414) * sigstore: `RekorEntryMissing -> `LogEntryMissing` Signed-off-by: William Woodruff * CHANGELOG: record changes Signed-off-by: William Woodruff Signed-off-by: William Woodruff Signed-off-by: Jack Leightcap --- CHANGELOG.md | 3 +++ sigstore/_cli.py | 6 +++--- sigstore/verify/__init__.py | 4 ++-- sigstore/verify/verifier.py | 10 ++++++---- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a78642d03..04cfedf63 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,9 @@ All versions prior to 0.9.0 are untracked. have been renamed to removed implementation detail references ([#402](https://github.com/sigstore/sigstore-python/pull/402)) +* `sigstore.transparency.RekorEntryMissing` is now `LogEntryMissing` + ([#414](https://github.com/sigstore/sigstore-python/pull/414)) + ## [0.10.0] ### Added diff --git a/sigstore/_cli.py b/sigstore/_cli.py index cb8c6af2d..035f6617e 100644 --- a/sigstore/_cli.py +++ b/sigstore/_cli.py @@ -45,7 +45,7 @@ from sigstore.transparency import LogEntry from sigstore.verify import ( CertificateVerificationFailure, - RekorEntryMissing, + LogEntryMissing, VerificationFailure, VerificationMaterials, Verifier, @@ -852,7 +852,7 @@ def _verify_identity(args: argparse.Namespace) -> None: ), file=sys.stderr, ) - elif isinstance(result, RekorEntryMissing): + elif isinstance(result, LogEntryMissing): # If Rekor lookup failed, it's because the certificate either # wasn't logged after creation or because the user requested the # wrong Rekor instance (e.g., staging instead of production). @@ -943,7 +943,7 @@ def _verify_github(args: argparse.Namespace) -> None: ), file=sys.stderr, ) - elif isinstance(result, RekorEntryMissing): + elif isinstance(result, LogEntryMissing): # If Rekor lookup failed, it's because the certificate either # wasn't logged after creation or because the user requested the # wrong Rekor instance (e.g., staging instead of production). diff --git a/sigstore/verify/__init__.py b/sigstore/verify/__init__.py index 6bfcba3c9..03b9d3f0e 100644 --- a/sigstore/verify/__init__.py +++ b/sigstore/verify/__init__.py @@ -59,13 +59,13 @@ ) from sigstore.verify.verifier import ( CertificateVerificationFailure, - RekorEntryMissing, + LogEntryMissing, Verifier, ) __all__ = [ "CertificateVerificationFailure", - "RekorEntryMissing", + "LogEntryMissing", "Verifier", "VerificationResult", "VerificationSuccess", diff --git a/sigstore/verify/verifier.py b/sigstore/verify/verifier.py index 8704db3cc..5ea3919db 100644 --- a/sigstore/verify/verifier.py +++ b/sigstore/verify/verifier.py @@ -56,13 +56,15 @@ logger = logging.getLogger(__name__) -class RekorEntryMissing(VerificationFailure): +class LogEntryMissing(VerificationFailure): """ - A specialization of `VerificationFailure` for Rekor lookup failures, + A specialization of `VerificationFailure` for transparency log lookup failures, with additional lookup context. """ - reason: str = "Rekor has no entry for the given verification materials" + reason: str = ( + "The transparency log has no entry for the given verification materials" + ) signature: str """ @@ -232,7 +234,7 @@ def verify( try: entry = materials.rekor_entry(self._rekor) except RekorEntryMissingError: - return RekorEntryMissing( + return LogEntryMissing( signature=base64.b64encode(materials.signature).decode(), artifact_hash=materials.input_digest.hex(), )