Add support for verifying helm charts using provenance file #605
+1,050
−70
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
Binary file not shown.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| -----BEGIN PGP SIGNED MESSAGE----- | ||
| Hash: SHA512 | ||
|
|
||
| apiVersion: v2 | ||
| appVersion: 1.16.0 | ||
| description: A Helm chart for Kubernetes | ||
| name: helmchart | ||
| type: application | ||
| version: 0.1.0 | ||
|
|
||
| ... | ||
| files: | ||
| helmchart-0.1.0.tgz: sha256:007c7b7446eebcb18caeffe9898a3356ba1795f54df40ad39cfcc7382874a10a | ||
| -----BEGIN PGP SIGNATURE----- | ||
|
|
||
| wsDcBAEBCgAQBQJiKwNBCRBwNbqX0yqHwQAACj8MABCY6mVrWaJdC64PbhTTonVE | ||
| 97MZZpQBT+CZIRAecfkvcTeMTBeKh/yRwsSmjwo46eKOpNFJ1eQVHqVcKWLfBn3Z | ||
| AijuXTaISl8SnQyKPF2Z8n+YrYwh9OWPUX2CpUQstx+snSLDuv5ltWIgRlzfHAUN | ||
| hwzsgjs8bpHe8wZTgnASUVbcMMYQXCcovbXB6NATDLkZLHBWWEISicOl6VYLLl2D | ||
| kZg7LDcDKPcPmKJ6WtVurkyWXhK3jdYzlaOQWjs2nLIH/CdlmAygELuWexsOZAhY | ||
| MEauKEMoVzDQF5oaNA78AzlBLGogxao5fBYtAAHGb5tQdnVRUeSci+7IR0LHsS05 | ||
| YF/UnUF69GSESfoKIBvQuzex4BRCLBwayq6CSyrpZQ2+Vg4ARPo7LFg7Wy0zvC9Z | ||
| NxGnIeh1az9hltdzPgg6ZahPZB+eMF+t9ouAz9OZ3kxYUDmoE+Z+NqRWsPi27Cxk | ||
| CSw9EfJfDsputN/wj4NAxZKfqauMtS5sgaSgtrW+zA== | ||
| =mfBq | ||
| -----END PGP SIGNATURE----- |
Binary file not shown.
Binary file not shown.
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,95 @@ | ||||||
| /* | ||||||
| Copyright 2021 The Flux authors | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| you may not use this file except in compliance with the License. | ||||||
| You may obtain a copy of the License at | ||||||
| http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| Unless required by applicable law or agreed to in writing, software | ||||||
| distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| See the License for the specific language governing permissions and | ||||||
| limitations under the License. | ||||||
| */ | ||||||
|
|
||||||
| package chart | ||||||
darkowlzz marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| import ( | ||||||
| "fmt" | ||||||
| "io" | ||||||
| "os" | ||||||
| "path/filepath" | ||||||
| "strings" | ||||||
|
|
||||||
| "golang.org/x/crypto/openpgp" | ||||||
| "helm.sh/helm/v3/pkg/provenance" | ||||||
| ) | ||||||
|
|
||||||
| // Ref: https://github.com/helm/helm/blob/v3.8.0/pkg/downloader/chart_downloader.go#L328 | ||||||
| // modified to accept a custom provenance file path and an actual keyring instead of a | ||||||
| // path to the file containing the keyring. | ||||||
| func verifyChartWithProvFile(keyring io.Reader, chartPath, provFilePath string) (*provenance.Verification, error) { | ||||||
aryan9600 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| switch fi, err := os.Stat(chartPath); { | ||||||
| case err != nil: | ||||||
| return nil, err | ||||||
| case fi.IsDir(): | ||||||
| return nil, fmt.Errorf("unpacked charts cannot be verified") | ||||||
| case !isTar(chartPath): | ||||||
| return nil, fmt.Errorf("chart must be a tgz file") | ||||||
| } | ||||||
|
|
||||||
| if provFilePath == "" { | ||||||
| provFilePath = chartPath + ".prov" | ||||||
| } | ||||||
|
|
||||||
| if _, err := os.Stat(provFilePath); err != nil { | ||||||
| return nil, fmt.Errorf("could not load provenance file %s: %w", provFilePath, err) | ||||||
| } | ||||||
|
|
||||||
| ring, err := openpgp.ReadKeyRing(keyring) | ||||||
| if err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| sig := &provenance.Signatory{KeyRing: ring} | ||||||
| verification, err := sig.Verify(chartPath, provFilePath) | ||||||
| if err != nil { | ||||||
| err = fmt.Errorf("failed to verify helm chart using provenance file: %w", err) | ||||||
| } | ||||||
| return verification, err | ||||||
| } | ||||||
|
|
||||||
| // isTar tests whether the given file is a tar file. | ||||||
| func isTar(filename string) bool { | ||||||
| return strings.EqualFold(filepath.Ext(filename), ".tgz") | ||||||
| } | ||||||
|
|
||||||
| // Returns the path of a provenance file related to a packaged chart by | ||||||
| // adding ".prov" at the end, as per the Helm convention. | ||||||
| func provenanceFilePath(path string) string { | ||||||
| return path + ".prov" | ||||||
| } | ||||||
|
|
||||||
| // ref: https://github.com/helm/helm/blob/v3.8.0/pkg/action/verify.go#L47-L51 | ||||||
| type VerificationSignature struct { | ||||||
| Identity string | ||||||
| KeyFingerprint [20]byte | ||||||
| FileHash string | ||||||
| } | ||||||
|
|
||||||
| func buildVerificationSig(ver *provenance.Verification) *VerificationSignature { | ||||||
| var verSig VerificationSignature | ||||||
| if ver != nil { | ||||||
| if ver.SignedBy != nil { | ||||||
| for name := range ver.SignedBy.Identities { | ||||||
| verSig.Identity = name | ||||||
| break | ||||||
| } | ||||||
| } | ||||||
| verSig.FileHash = ver.FileHash | ||||||
| verSig.KeyFingerprint = ver.SignedBy.PrimaryKey.Fingerprint | ||||||
| } | ||||||
| return &verSig | ||||||
| } | ||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package chart | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| func Test_verifyChartWithProvFile(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| keyring, err := os.Open("../testdata/charts/pub.gpg") | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| ver, err := verifyChartWithProvFile(keyring, "../testdata/charts/helmchart-0.1.0.tgz", "../testdata/charts/helmchart-0.1.0.tgz.prov") | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| g.Expect(ver).ToNot(BeNil()) | ||
| } |
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
Binary file not shown.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| -----BEGIN PGP SIGNED MESSAGE----- | ||
| Hash: SHA512 | ||
|
|
||
| apiVersion: v2 | ||
| appVersion: 1.16.0 | ||
| description: A Helm chart for Kubernetes | ||
| name: helmchart | ||
| type: application | ||
| version: 0.1.0 | ||
|
|
||
| ... | ||
| files: | ||
| helmchart-0.1.0.tgz: sha256:c6c5a41ff83f415e18d2ed8ab3a386021e3f1742ea3d1bc0ba759a09aaeb8f2a | ||
| -----BEGIN PGP SIGNATURE----- | ||
|
|
||
| wsDcBAEBCgAQBQJiIwjxCRCDj6SUu5W1LwAAndgMAEDZsARwLEczJYw3lKYeftcy | ||
| lebfr81jxNS1a4J2DQvOEcltdA1MBHBoir3GoG53xjMWMYMKLUj0FQLQFoLwHTvf | ||
| zl5KkfMQnH85KL5TAbzm+Oiz/WiKYQ9cza5T+50WoXFVjdfoF6efZ6tOxV+FtS/o | ||
| toga+N8z4FtkhbuY0qQx4nxM2wRd/XZHPFO0LRx+Z8E5lghedLOD7ocV7kN/FD9p | ||
| 0/MMZ5kpeLevfnp4GBYjZKxojH8eOFni7WPovHUts/QHvEnYxucNwej8OTIy699w | ||
| APJbwEV3BVwzjqgsfywQxH80JEpNGzCRUt5yfnXpF4IUxzPVM1z2tp+/leoHxkxw | ||
| yfhL8FVfUbWnWvqIMY8QK6zhkqy22jb4lFE7jPEUwVu+HQc6KTzkYhZQQ5fOHmoa | ||
| pYsCbAF/AMZ1U8yT6OljVF904yIiLohR7F6s/maEu6mCdy82sNjpCdasuThqe7k0 | ||
| Hv4m4NcrULqhvKyyAqp/XgWMPeNuFkq3wqBk1DxLTw== | ||
| =oQfE | ||
| -----END PGP SIGNATURE----- |
Binary file not shown.
Binary file not shown.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| Copyright 2022 The Flux authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package util | ||
aryan9600 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/fluxcd/source-controller/internal/fs" | ||
| ) | ||
|
|
||
| func writeBytesToFile(bytes []byte, file *os.File) error { | ||
| if _, err := file.Write(bytes); err != nil { | ||
| _ = file.Close() | ||
| return fmt.Errorf("failed to write to file %s: %w", file.Name(), err) | ||
| } | ||
| if err := file.Close(); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Writes the provided bytes to a temp file with the name provided in the path and | ||
| // returns the file handle. If renameToOriginal is true, it renames the temp file to | ||
| // the intended file name (since temp file names have random bytes as suffix). | ||
| func WriteToTempFile(bytes []byte, out string, renameToOriginal bool) (*os.File, error) { | ||
| file, err := os.CreateTemp("", filepath.Base(out)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create temporary file %s: %w", filepath.Base(out), err) | ||
| } | ||
| err = writeBytesToFile(bytes, file) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if renameToOriginal { | ||
| err = fs.RenameWithFallback(file.Name(), filepath.Join("/tmp", filepath.Base(out))) | ||
| file, err = os.Open(filepath.Join("/tmp", filepath.Base(out))) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to rename temporary file %s: %w", filepath.Base(out), err) | ||
| } | ||
| } | ||
| return file, nil | ||
| } | ||
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.
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.
SecretRefandVerificationKeyringcan have some description for documentation purposes.