Skip to content

[series/3.6.x] Better error when verifying rekorv2 entries#1565

Merged
jku merged 2 commits into
sigstore:series/3.6.xfrom
jku:Better-error-for-rekorv2
Oct 7, 2025
Merged

[series/3.6.x] Better error when verifying rekorv2 entries#1565
jku merged 2 commits into
sigstore:series/3.6.xfrom
jku:Better-error-for-rekorv2

Conversation

@jku

@jku jku commented Oct 6, 2025

Copy link
Copy Markdown
Member
  • Improve error message when verifying with 3.6.x but the bundle contains a rekor v2 entry: Current error is technically correct but not very helpful
  • Bump version as well (I can drop this if we don't want to make point release quite yet)

New error looks like this (the format is the same as some existing bundle errors):

ERROR    The provided bundle contains a transparency log entry that is incompatible with
         this version of sigstore-python. Please upgrade your verifying client.

         Additional context:

         Expected log entry version 0.0.1, got 0.0.2

         For detailed error information, run sigstore with the `--verbose` flag.

Fixes #1564.

@jku jku changed the title Better error for verifying rekorv2 on 3.6.x [series/3.6.x] Better error for verifying rekorv2 entries Oct 6, 2025
jku added 2 commits October 6, 2025 15:21
Currently the error is technically correct but confusing
"VerificationError: not enough sources of verified time"

Replace that with:

    ERROR    The provided bundle contains a transparency log entry that is incompatible with
             this version of sigstore-python. Please upgrade your verifying client.

             Additional context:

             Expected log entry version 0.0.1, got 0.0.2

             For detailed error information, run sigstore with the `--verbose` flag.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
@jku jku force-pushed the Better-error-for-rekorv2 branch from 1228979 to a550c33 Compare October 6, 2025 12:21
@jku

jku commented Oct 6, 2025

Copy link
Copy Markdown
Member Author

FYI @di we discussed this on friday, it does look like the error could be better here.

@jku jku changed the title [series/3.6.x] Better error for verifying rekorv2 entries [series/3.6.x] Better error when verifying rekorv2 entries Oct 6, 2025

@woodruffw woodruffw left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@jku out of curiosity, do you have thoughts on how long the 3.6.x series should be maintained? My first intuition here is to say that we should stop doing QOL improvements to it pretty soon now that 4.x is released, but I imagine there's still a significant usage tail that we need to move over to 4.x. Curious what you think.

@di di left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(we should do the same for the 4.x series as well...)

@di

di commented Oct 6, 2025

Copy link
Copy Markdown
Member

@woodruffw, @jku has put together a nice set of client stats here, as expected the 3.x series has a lot of usage (seems like this is mostly due to gh-actions-pypi-publish using this version)

IMO, we mostly just need a 3.x release with a useful error message when verifying newer entries (which this PR resolves). I don't think we need to maintain this series beyond that.

@di

di commented Oct 6, 2025

Copy link
Copy Markdown
Member

Bump version as well (I can drop this if we don't want to make point release quite yet)

I think this is fine, I don't think there's anything else we need to get into a 3.x release.

@jku

jku commented Oct 6, 2025

Copy link
Copy Markdown
Member Author

@jku out of curiosity, do you have thoughts on how long the 3.6.x series should be maintained? My first intuition here is to say that we should stop doing QOL improvements to it pretty soon now that 4.x is released, but I imagine there's still a significant usage tail that we need to move over to 4.x. Curious what you think.

  • QOL changes, I would hope we don't do any after this
  • bug fixes or even something like cryptography version pin updates: we may want to do those for a while

Speaking of cryptography version pin bumps: should we do that in 3.6.6 or no? On one hand we would like library users to upgrade to sigstore 4.0 but I also recognise how very annoying a library pinning another library (especially cryptography) is...

@jku jku merged commit e1f762d into sigstore:series/3.6.x Oct 7, 2025
22 checks passed
@jku

jku commented Oct 7, 2025

Copy link
Copy Markdown
Member Author

Speaking of cryptography version pin bumps: should we do that in 3.6.6 or no? On one hand we would like library users to upgrade to sigstore 4.0 but I also recognise how very annoying a library pinning another library (especially cryptography) is...

I will make a PR of that but either way works for me.

jku added a commit to jku/sigstore-python that referenced this pull request Oct 9, 2025
This is a forward port of sigstore#1565 to future proof the error message.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
jku added a commit that referenced this pull request Oct 11, 2025
….0 (#1569)

* models: Forward-port the entry kind version error improvement

This is a forward port of #1565 to future proof the error message.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>

* Changelog: Update for 4.1.0

Add missing entries, also add the 3.6.6 changelog from series/3.6.x

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>

* Bump version to 4.1.0

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>

---------

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
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