feat: refactor error messages for cosign verification #230
Conversation
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
binbin-li
force-pushed
the
refactor-cosign-msg
branch
2 times, most recently
from
0e31b2f to
dd98fe2
Compare
12 tasks
binbin-li
force-pushed
the
refactor-cosign-msg
branch
8 times, most recently
from
86e32c9 to
fac5b5a
Compare
binbin-li
force-pushed
the
refactor-error-msg
branch
from
c258392 to
65617a1
Compare
binbin-li
force-pushed
the
refactor-cosign-msg
branch
2 times, most recently
from
99bd939 to
7bd896d
Compare
yizha1
reviewed
Sep 9, 2024
pkg/verifier/cosign/cosign.go
Outdated
| } | ||
|
|
||
| config, err := parseVerifierConfig(verifierConfig) | ||
| if err != nil { | ||
| return nil, re.ErrorCodeConfigInvalid.WithComponentType(re.Verifier).WithPluginName(verifierName) | ||
| return nil, re.ErrorCodeConfigInvalid.WithDetail("Failed to create Cosign Verifier").WithError(err) |
There was a problem hiding this comment.
Suggested change
| return nil, re.ErrorCodeConfigInvalid.WithDetail("Failed to create Cosign Verifier").WithError(err) | |
| return nil, re.ErrorCodeConfigInvalid.WithDetail("Failed to create the Cosign Verifier").WithError(err) |
pkg/verifier/cosign/trustpolicy.go
Outdated
| } | ||
| cosignOpts.RootCerts = roots | ||
| if tp.config.Keyless.CTLogVerify != nil && *tp.config.Keyless.CTLogVerify { | ||
| cosignOpts.CTLogPubKeys, err = cosign.GetCTLogPubs(ctx) | ||
| if err != nil { | ||
| return cosignOpts, fmt.Errorf("failed to fetch certificate transparency log public keys: %w", err) | ||
| return cosignOpts, re.ErrorCodeVerifyPluginFailure.WithDetail("Failed to fetch certificate transparency log public keys").WithError(err).WithRemediation("Please check if TUF root is experiencing any outages") |
There was a problem hiding this comment.
Suggested change
| return cosignOpts, re.ErrorCodeVerifyPluginFailure.WithDetail("Failed to fetch certificate transparency log public keys").WithError(err).WithRemediation("Please check if TUF root is experiencing any outages") | |
| return cosignOpts, re.ErrorCodeVerifyPluginFailure.WithDetail("Failed to fetch public keys of the certificate transparency log").WithError(err).WithRemediation("Please check if TUF root is available") |
pkg/verifier/cosign/trustpolicy.go
Outdated
| } | ||
| } else { | ||
| cosignOpts.IgnoreSCT = true | ||
| } | ||
| cosignOpts.IntermediateCerts, err = fulcio.GetIntermediates() | ||
| if err != nil { | ||
| return cosignOpts, fmt.Errorf("failed to get fulcio intermediate certificates: %w", err) | ||
| return cosignOpts, re.ErrorCodeVerifyPluginFailure.WithDetail("Failed to get fulcio intermediate certificates").WithError(err).WithRemediation("Please check if Fulcio is experiencing any outages") |
There was a problem hiding this comment.
Suggested change
| return cosignOpts, re.ErrorCodeVerifyPluginFailure.WithDetail("Failed to get fulcio intermediate certificates").WithError(err).WithRemediation("Please check if Fulcio is experiencing any outages") | |
| return cosignOpts, re.ErrorCodeVerifyPluginFailure.WithDetail("Failed to get fulcio intermediate certificates").WithError(err).WithRemediation("Please check if Fulcio is available") |
| } | ||
|
|
||
| for _, keyConfig := range config.Keys { | ||
| // check if the key is defined by file path or by key management provider | ||
| if keyConfig.File == "" && keyConfig.Provider == "" { | ||
| return re.ErrorCodeConfigInvalid.WithComponentType(re.Verifier).WithPluginName(verifierName).WithDetail(fmt.Sprintf("trust policy %s failed: key management provider name is required when not using file path", config.Name)) | ||
| return re.ErrorCodeConfigInvalid.WithDetail(fmt.Sprintf("Invalid trust policy %s: key management provider name is required when not using file path", config.Name)) |
There was a problem hiding this comment.
Suggested change
| return re.ErrorCodeConfigInvalid.WithDetail(fmt.Sprintf("Invalid trust policy %s: key management provider name is required when not using file path", config.Name)) | |
| return re.ErrorCodeConfigInvalid.WithDetail(fmt.Sprintf("Invalid trust policy %s: key management provider name is required if not using file path", config.Name)) |
| } | ||
|
|
||
| if config.Name == "" { | ||
| return re.ErrorCodeConfigInvalid.WithComponentType(re.Verifier).WithPluginName(verifierName).WithDetail("missing trust policy name") | ||
| return re.ErrorCodeConfigInvalid.WithDetail("name parameter is required in trust policy configuration").WithRemediation("Please provide a name for the trust policy.") |
There was a problem hiding this comment.
Suggested change
| return re.ErrorCodeConfigInvalid.WithDetail("name parameter is required in trust policy configuration").WithRemediation("Please provide a name for the trust policy.") | |
| return re.ErrorCodeConfigInvalid.WithDetail("The name parameter is required in trust policy configuration").WithRemediation("Please provide a name for the trust policy.") |
| } | ||
|
|
||
| if len(config.Scopes) == 0 { | ||
| return re.ErrorCodeConfigInvalid.WithComponentType(re.Verifier).WithPluginName(verifierName).WithDetail(fmt.Sprintf("trust policy %s failed: no scopes defined", config.Name)) | ||
| return re.ErrorCodeConfigInvalid.WithDetail(fmt.Sprintf("scopes parameter is required in trust policy configuration %s", config.Name)).WithRemediation("Please provide at least one scope for the trust policy.") |
There was a problem hiding this comment.
Suggested change
| return re.ErrorCodeConfigInvalid.WithDetail(fmt.Sprintf("scopes parameter is required in trust policy configuration %s", config.Name)).WithRemediation("Please provide at least one scope for the trust policy.") | |
| return re.ErrorCodeConfigInvalid.WithDetail(fmt.Sprintf("The scopes parameter is required in trust policy configuration %s", config.Name)).WithRemediation("Please provide at least one scope for the trust policy.") |
binbin-li
force-pushed
the
refactor-cosign-msg
branch
2 times, most recently
from
0c99179 to
51d56e5
Compare
binbin-li
force-pushed
the
refactor-cosign-msg
branch
from
b10327e to
2a44030
Compare
…ject#1779) Co-authored-by: Binbin Li <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #
Type of change
Please delete options that are not relevant.
mainbranch)How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration
Checklist:
Post Merge Requirements
Helm Chart Change