Repository navigation
fix(sign): sign and verify v1 Tasks and Pipelines as v1 - #3376
Open
shubhamrai9122-creator wants to merge 1 commit into
Open
shubhamrai9122-creator wants to merge 1 commit into
shubhamrai9122-creator wants to merge 1 commit into
Conversation
tkn task sign, tkn pipeline sign and their verify commands decoded every
resource as v1beta1, even with apiVersion tekton.dev/v1. Marshalling the
v1beta1 Step added "resources: {}" to every step, which Tekton Pipelines
rejects with 'strict decoding error: unknown field
"spec.steps[0].resources"', and it dropped v1-only fields such as
computeResources from the signed file.
Decode the resource as the type of its apiVersion, so a v1 resource keeps
its fields and is signed over the same bytes Tekton Pipelines checksums
when it verifies it. Resources without a tekton.dev/v1 apiVersion are
still decoded as v1beta1.
Fixes tektoncd#2894
Signed-off-by: shubhamrai9122-creator <shubhamrai9122@gmail.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Contributor
Author
|
/assign @vdemeester |
This file contains hidden or 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
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.
Changes
Fixes #2894
tkn task sign,tkn pipeline signand theirverifycommands decoded every file as v1beta1, even withapiVersion: tekton.dev/v1. Marshalling the v1beta1Stepwroteresources: {}into each step, which Tekton Pipelines rejects (strict decoding error: unknown field "spec.steps[0].resources"). It also silently dropped v1-only fields: a step'scomputeResourceswas missing from the signed file.This adds
trustedresources.Decode, which reads theapiVersionand decodes atekton.dev/v1Task or Pipeline into the v1 type. The four commands andUnmarshalCRDuse it. A file without atekton.dev/v1apiVersion is still decoded as v1beta1, as before. Because a v1 resource is now marshalled with the v1 type, the signature covers the same bytes Tekton Pipelines hashes inv1.Task.Checksum()/v1.Pipeline.Checksum(). That's probably also the sign/verify mismatch mentioned at the end of the issue.Tests in
pkg/trustedresources:TestDecodechecks the type chosen for v1, v1beta1 and missing apiVersions.TestSignV1signs a v1 Task (withcomputeResources) and a v1 Pipeline (with an inlinetaskSpec). It decodes the signed file strictly into the v1 type, as Pipelines does, and verifies the signature against Pipelines' ownChecksum(). Run against the old behaviour, both cases fail withjson: unknown field "resources".Submitter Checklist
make check(rangofmt,go vetandgo test -mod=vendor ./...; everything passes exceptTestDeterministicLayers/TestDeterministicManifestinpkg/bundle, which fail the same way onmainon my machine)make generated(no flag or help text changes)Release Notes