-
Couldn't load subscription status.
- Fork 643
Deprecate offline flag #4457
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
Deprecate offline flag #4457
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4457 +/- ##
==========================================
- Coverage 40.10% 35.36% -4.74%
==========================================
Files 155 220 +65
Lines 10044 15160 +5116
==========================================
+ Hits 4028 5362 +1334
- Misses 5530 9110 +3580
- Partials 486 688 +202 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
8f82ee3 to
41b620a
Compare
cmd/cosign/cli/options/verify.go
Outdated
| func (o *CommonVerifyOptions) AddFlags(cmd *cobra.Command) { | ||
| cmd.Flags().BoolVar(&o.Offline, "offline", false, | ||
| "only allow offline verification") | ||
| "[deprecated] only verify an artifact's inclusion in a transparency log using a provided proof, rather than querying the log. May still include network requests to retrieve service keys from a TUF repository") |
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.
FYI it looks like using MarkDeprecated hides the flag from the --help output so I'm not sure it matters what's in this help text.
If it does appear somewhere, it might be better to change [deprecated] to DEPRECATED to match the deprecation format of the --attachment flag.
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.
Good point, I've removed [deprecated] since the flag help text is no longer used. Looking around, we also have [DEPRECATED] for --sig-only - I'll look at standardizing as we deprecate more flags.
41b620a to
63b6df3
Compare
The offline flag is misleading and is a no-op with the new Cosign v3 defaults. The flag's purpose was to prevent a client from falling back to verifying an artifact's inclusion in Rekor when a proof failed to verify. Most users thought offline verification forced the client to not make any network requests - a very reasonable assumption, but with TUF, network requests are a part of verification if the local TUF metadata has expired. I've updated the README as well, though we need to make a far more comprehensive pass over the documentation since it's out of date given our new trusted-root/bundle flags. Fixes sigstore#4454 Signed-off-by: Hayden <[email protected]>
63b6df3 to
716a659
Compare
The offline flag is misleading and is a no-op with the new Cosign v3 defaults. The flag's purpose was to prevent a client from falling back to verifying an artifact's inclusion in Rekor when a proof failed to verify. Most users thought offline verification forced the client to not make any network requests - a very reasonable assumption, but with TUF, network requests are a part of verification if the local TUF metadata has expired.
I've updated the README as well, though we need to make a far more comprehensive pass over the documentation since it's out of date given our new trusted-root/bundle flags.
Fixes #4454
Summary
Release Note
Documentation