Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Enable Witness Policy verify from Archivista (#438)
* feat: Enable Witness Policy verify from Archivista Enables Witness to retrieve Policy from Archivista. If a user provides a Policy `gitoid`, Witness will attempt to retrieve it from Archivista. To maintain backward compatibility, Witness first tries to load the file locally. If the local file loading fails and an Archivista is configured, it will retrieve the Policy from Archivista. --------- Signed-off-by: Kairo Araujo <kairo.araujo@testifysec.com>
- Loading branch information
1 parent
3a926ef
commit 0cd05b6
Showing
9 changed files
with
257 additions
and
19 deletions.
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright 2024 The Witness Contributors | ||
| // | ||
| // 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 archivista | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/in-toto/go-witness/archivista" | ||
| "github.com/in-toto/go-witness/dsse" | ||
| ) | ||
|
|
||
| type aClient struct { | ||
| url string | ||
| client Clienter | ||
| } | ||
|
|
||
| // Define Client Interface for Archivista | ||
| type Clienter interface { | ||
| Download(ctx context.Context, gitoid string) (dsse.Envelope, error) | ||
| Store(ctx context.Context, env dsse.Envelope) (string, error) | ||
| SearchGitoids(ctx context.Context, vars archivista.SearchGitoidVariables) ([]string, error) | ||
| } | ||
|
|
||
| func NewArchivistaClient(url string, client *archivista.Client) Clienter { | ||
|
|
||
| if client == nil { | ||
| return nil | ||
| } | ||
|
|
||
| return &aClient{ | ||
| url: url, | ||
| client: client, | ||
| } | ||
| } | ||
|
|
||
| func (ac *aClient) Download(ctx context.Context, gitoid string) (dsse.Envelope, error) { | ||
| return ac.client.Download(ctx, gitoid) | ||
| } | ||
|
|
||
| func (ac *aClient) Store(ctx context.Context, env dsse.Envelope) (string, error) { | ||
| return ac.client.Store(ctx, env) | ||
| } | ||
|
|
||
| func (ac *aClient) SearchGitoids(ctx context.Context, vars archivista.SearchGitoidVariables) ([]string, error) { | ||
| return ac.client.SearchGitoids(ctx, vars) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Copyright 2024 The Witness Contributors | ||
| // | ||
| // 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 policy | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/in-toto/go-witness/dsse" | ||
| "github.com/in-toto/go-witness/log" | ||
| "github.com/in-toto/witness/internal/archivista" | ||
| ) | ||
|
|
||
| // Load policy from a file or Archivista | ||
| // | ||
| // It prefers to load from a file, if it fails, it tries to load from Archivista | ||
| func LoadPolicy(ctx context.Context, policy string, ac archivista.Clienter) (dsse.Envelope, error) { | ||
| policyEnvelope := dsse.Envelope{} | ||
|
|
||
| filePolicy, err := os.Open(policy) | ||
| if err != nil { | ||
| log.Debug("failed to open policy file: ", policy) | ||
| if ac == nil { | ||
| return policyEnvelope, fmt.Errorf("failed to open file to sign: %w", err) | ||
| } else { | ||
| log.Debug("attempting to fetch policy " + policy + " from archivista") | ||
| policyEnvelope, err = ac.Download(ctx, policy) | ||
| if err != nil { | ||
| return policyEnvelope, fmt.Errorf("failed to fetch policy from archivista: %w", err) | ||
| } | ||
| log.Debug("policy " + policy + " downloaded from archivista") | ||
| } | ||
|
|
||
| } else { | ||
| defer filePolicy.Close() | ||
| decoder := json.NewDecoder(filePolicy) | ||
| if err := decoder.Decode(&policyEnvelope); err != nil { | ||
| return policyEnvelope, fmt.Errorf("could not unmarshal policy envelope: %w", err) | ||
| } | ||
| } | ||
|
|
||
| return policyEnvelope, nil | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // Copyright 2024 The Witness Contributors | ||
| // | ||
| // 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 policy | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/in-toto/go-witness/dsse" | ||
| "github.com/in-toto/witness/internal/archivista" | ||
| "github.com/stretchr/testify/mock" | ||
| "github.com/stretchr/testify/suite" | ||
| ) | ||
|
|
||
| // Mock archivista client | ||
| type ArchivistaClienterMock struct { | ||
| mock.Mock | ||
| archivista.Clienter | ||
| } | ||
|
|
||
| func (m *ArchivistaClienterMock) Download(ctx context.Context, path string) (dsse.Envelope, error) { | ||
| args := m.Called() | ||
| return dsse.Envelope{}, args.Error(1) | ||
| } | ||
|
|
||
| // Define test suite | ||
| type UTPolicySuite struct { | ||
| suite.Suite | ||
| mockedAC *ArchivistaClienterMock | ||
| } | ||
|
|
||
| func TestUTPolicySuite(t *testing.T) { | ||
| suite.Run(t, new(UTPolicySuite)) | ||
| } | ||
|
|
||
| // Setup test suite | ||
| func (ut *UTPolicySuite) SetupTest() { | ||
| ut.mockedAC = &ArchivistaClienterMock{} | ||
|
|
||
| } | ||
|
|
||
| // Test LoadPolicy with file | ||
| func (ut *UTPolicySuite) TestLoadPolicyFile() { | ||
| ctx := context.Background() | ||
| policy := "../../test/policy-hello-signed.json" | ||
|
|
||
| // Load policy from file | ||
| policyEnvelope, err := LoadPolicy(ctx, policy, nil) | ||
| ut.NoError(err) | ||
| ut.NotNil(policyEnvelope) | ||
| } | ||
|
|
||
| // Test LoadPolicy with file not found | ||
| func (ut *UTPolicySuite) TestLoadPolicyFileNotFound() { | ||
| ctx := context.Background() | ||
| policy := "notfound" | ||
|
|
||
| // Load policy from file | ||
| _, err := LoadPolicy(ctx, policy, nil) | ||
| ut.Error(err) | ||
| ut.Contains(err.Error(), "no such file or directory") | ||
| } | ||
|
|
||
| // Test LoadPolicy with archivista | ||
| func (ut *UTPolicySuite) TestLoadPolicyArchivista() { | ||
| ctx := context.Background() | ||
| policy := "testgitoid" | ||
|
|
||
| // Mock archivista client | ||
| ut.mockedAC.On("Download").Return(dsse.Envelope{}, nil) | ||
|
|
||
| // Load policy from archivista | ||
| policyEnvelope, err := LoadPolicy(ctx, policy, ut.mockedAC) | ||
| ut.NoError(err) | ||
| ut.NotNil(policyEnvelope) | ||
| } | ||
|
|
||
| // Test LoadPolicy with archivista not found | ||
| func (ut *UTPolicySuite) TestLoadPolicyArchivistaNotFound() { | ||
| ctx := context.Background() | ||
| policy := "testgitoid" | ||
|
|
||
| // Mock archivista client | ||
| ut.mockedAC.On("Download").Return(dsse.Envelope{}, errors.New("not found")) | ||
|
|
||
| // Load policy from archivista | ||
| _, err := LoadPolicy(ctx, policy, ut.mockedAC) | ||
| ut.Error(err) | ||
| ut.Contains(err.Error(), "failed to fetch policy from archivista") | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "payload": "ewogICAgImV4cGlyZXMiOiAiMjAzNS0xMi0xN1QyMzo1Nzo0MC0wNTowMCIsCiAgICAibmFtZSI6ICJidWlsZC1oZWxsbyIsCiAgICAic3RlcHMiOiB7CiAgICAgICJyZWxlYXNlIjogewogICAgICAgICJuYW1lIjogInJlbGVhc2UiLAogICAgICAgICJhdHRlc3RhdGlvbnMiOiBbCiAgICAgICAgICB7CiAgICAgICAgICAgICJ0eXBlIjogImh0dHBzOi8vd2l0bmVzcy5kZXYvYXR0ZXN0YXRpb25zL2NvbW1hbmQtcnVuL3YwLjEiLAogICAgICAgICAgICAicmVnb3BvbGljaWVzIjogWwogICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICJuYW1lIjogImV4cGVjdGVkIGV4aXQgY29kZSIsCiAgICAgICAgICAgICAgICAibW9kdWxlIjogImNHRmphMkZuWlNCamIyMXRZVzVrY25WdUNncGtaVzU1VzIxeloxMGdld29nSUNBZ2FXNXdkWFF1WlhocGRHTnZaR1VnSVQwZ01Bb2dJQ0FnYlhObklEbzlJQ0psZUdsMFkyOWtaU0J1YjNRZ01DSUtmUW89IgogICAgICAgICAgICAgIH0KICAgICAgICAgICAgXQogICAgICAgICAgfSwKICAgICAgICAgIHsKICAgICAgICAgICAgInR5cGUiOiAiaHR0cHM6Ly93aXRuZXNzLmRldi9hdHRlc3RhdGlvbnMvcHJvZHVjdC92MC4xIiwKICAgICAgICAgICAgInN1YmplY3RzY29wZXMiOiBbCiAgICAgICAgICAgICAgewogICAgICAgICAgICAgICAgInN1YmplY3QiOiAiZmlsZSIsCiAgICAgICAgICAgICAgICAic2NvcGUiOiAidGVzdC9oZWxsby50eHQiCiAgICAgICAgICAgICAgfQogICAgICAgICAgICBdCiAgICAgICAgICB9LAogICAgICAgICAgewogICAgICAgICAgICAidHlwZSI6ICJodHRwczovL3dpdG5lc3MuZGV2L2F0dGVzdGF0aW9ucy9lbnZpcm9ubWVudC92MC4xIgogICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgImZ1bmN0aW9uYXJpZXMiOiBbCiAgICAgICAgICB7CiAgICAgICAgICAgICJ0eXBlIjogInB1YmxpY2tleSIsCiAgICAgICAgICAgICJwdWJsaWNrZXlpZCI6ICJhd3NrbXM6Ly8vYXJuOmF3czprbXM6dXMtZWFzdC0xOjAwMDAwMDAwMDAwMDphbGlhcy9hd3Mta21zLWtleWlkLXRlc3QiCiAgICAgICAgICB9CiAgICAgICAgXQogICAgICB9CiAgICB9LAogICAgInB1YmxpY2tleXMiOiB7CiAgICAgICJhd3NrbXM6Ly8vYXJuOmF3czprbXM6dXMtZWFzdC0xOjAwMDAwMDAwMDAwMDphbGlhcy9hd3Mta21zLWtleWlkLXRlc3QiOiB7CiAgICAgICAgImtleWlkIjogImF3c2ttczovLy9hcm46YXdzOmttczp1cy1lYXN0LTE6MDAwMDAwMDAwMDAwOmFsaWFzL2F3cy1rbXMta2V5aWQtdGVzdCIKICAgICAgfQogICAgfQogIH0=", | ||
| "payloadType": "https://witness.testifysec.com/policy/v0.1", | ||
| "signatures": [ | ||
| { | ||
| "keyid": "awskms:///arn:aws:kms:us-east-1:000000000000:alias/aws-kms-keyid-test", | ||
| "sig": "MEUCICAdESkQlElhtUClriWKpLGIS6EOq+9EZfSpnmJGV3WcAiEAks2r7+9AyCYnzHUA6Ix3LOtE6pmEBe8eS/RkplQ8c3Y=" | ||
| } | ||
| ] | ||
| } |