-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wip: implement verification attestor that returns a slsa VSA"
Co-authored-by: Kris Coleman <[email protected]>
- Loading branch information
1 parent
03cf3f0
commit 19f27e9
Showing
7 changed files
with
366 additions
and
82 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,209 @@ | ||
package verification | ||
|
||
import ( | ||
"crypto" | ||
"crypto/x509" | ||
"encoding/json" | ||
"fmt" | ||
"time" | ||
|
||
"github.com/testifysec/go-witness/attestation" | ||
"github.com/testifysec/go-witness/cryptoutil" | ||
"github.com/testifysec/go-witness/dsse" | ||
"github.com/testifysec/go-witness/log" | ||
"github.com/testifysec/go-witness/policy" | ||
"github.com/testifysec/go-witness/slsa" | ||
"github.com/testifysec/go-witness/source" | ||
"github.com/testifysec/go-witness/timestamp" | ||
) | ||
|
||
const ( | ||
Name = "policyverify" | ||
Type = slsa.VerificationSummaryPredicate | ||
) | ||
|
||
var ( | ||
_ attestation.Subjecter = &Attestor{} | ||
_ attestation.Attestor = &Attestor{} | ||
) | ||
|
||
type Attestor struct { | ||
slsa.VerificationSummary | ||
|
||
policyEnvelope dsse.Envelope | ||
policyVerifiers []cryptoutil.Verifier | ||
collectionSource source.Sourcer | ||
subjectDigests []string | ||
} | ||
|
||
type Option func(*Attestor) | ||
|
||
func VerifyWithPolicyEnvelope(policyEnvelope dsse.Envelope) Option { | ||
return func(vo *Attestor) { | ||
vo.policyEnvelope = policyEnvelope | ||
} | ||
} | ||
|
||
func VerifyWithPolicyVerifiers(policyVerifiers []cryptoutil.Verifier) Option { | ||
return func(vo *Attestor) { | ||
for _, verifier := range policyVerifiers { | ||
vo.policyVerifiers = append(vo.policyVerifiers, verifier) | ||
} | ||
} | ||
} | ||
|
||
func VerifyWithSubjectDigests(subjectDigests []cryptoutil.DigestSet) Option { | ||
return func(vo *Attestor) { | ||
for _, set := range subjectDigests { | ||
for _, digest := range set { | ||
vo.subjectDigests = append(vo.subjectDigests, digest) | ||
} | ||
} | ||
} | ||
} | ||
|
||
func VerifyWithCollectionSource(source source.Sourcer) Option { | ||
return func(vo *Attestor) { | ||
vo.collectionSource = source | ||
} | ||
} | ||
|
||
func New(opts ...Option) *Attestor { | ||
a := &Attestor{} | ||
for _, opt := range opts { | ||
opt(a) | ||
} | ||
|
||
return a | ||
} | ||
|
||
func (vs *Attestor) Name() string { | ||
return Name | ||
} | ||
|
||
func (vs *Attestor) Type() string { | ||
return Type | ||
} | ||
|
||
func (vs *Attestor) RunType() attestation.RunType { | ||
return attestation.ExecuteRunType | ||
} | ||
|
||
func (vs *Attestor) Subjects() map[string]cryptoutil.DigestSet { | ||
panic("not implemented") // TODO: Implement | ||
} | ||
|
||
func (vo *Attestor) Attest(ctx *attestation.AttestationContext) error { | ||
if _, err := vo.policyEnvelope.Verify(dsse.VerifyWithVerifiers(vo.policyVerifiers...)); err != nil { | ||
return fmt.Errorf("could not verify policy: %w", err) | ||
} | ||
|
||
pol := policy.Policy{} | ||
if err := json.Unmarshal(vo.policyEnvelope.Payload, &pol); err != nil { | ||
return fmt.Errorf("failed to unmarshal policy from envelope: %w", err) | ||
} | ||
|
||
pubKeysById, err := pol.PublicKeyVerifiers() | ||
if err != nil { | ||
return fmt.Errorf("failed to get pulic keys from policy: %w", err) | ||
} | ||
|
||
pubkeys := make([]cryptoutil.Verifier, 0) | ||
for _, pubkey := range pubKeysById { | ||
pubkeys = append(pubkeys, pubkey) | ||
} | ||
|
||
trustBundlesById, err := pol.TrustBundles() | ||
if err != nil { | ||
return fmt.Errorf("failed to load policy trust bundles: %w", err) | ||
} | ||
|
||
roots := make([]*x509.Certificate, 0) | ||
intermediates := make([]*x509.Certificate, 0) | ||
for _, trustBundle := range trustBundlesById { | ||
roots = append(roots, trustBundle.Root) | ||
intermediates = append(intermediates, intermediates...) | ||
} | ||
|
||
timestampAuthoritiesById, err := pol.TimestampAuthorityTrustBundles() | ||
if err != nil { | ||
return fmt.Errorf("failed to load policy timestamp authorities: %w", err) | ||
} | ||
|
||
timestampVerifiers := make([]dsse.TimestampVerifier, 0) | ||
for _, timestampAuthority := range timestampAuthoritiesById { | ||
certs := []*x509.Certificate{timestampAuthority.Root} | ||
certs = append(certs, timestampAuthority.Intermediates...) | ||
timestampVerifiers = append(timestampVerifiers, timestamp.NewVerifier(timestamp.VerifyWithCerts(certs))) | ||
} | ||
|
||
verifiedSource := source.NewVerifiedSource( | ||
vo.collectionSource, | ||
dsse.VerifyWithVerifiers(pubkeys...), | ||
dsse.VerifyWithRoots(roots...), | ||
dsse.VerifyWithIntermediates(intermediates...), | ||
dsse.VerifyWithTimestampVerifiers(timestampVerifiers...), | ||
) | ||
|
||
policyResult, err := pol.Verify(ctx.Context(), policy.WithSubjectDigests(vo.subjectDigests), policy.WithVerifiedSource(verifiedSource)) | ||
if _, ok := err.(policy.ErrPolicyDenied); ok { | ||
vo.VerificationSummary, err = verificationSummaryFromResults(vo.policyEnvelope, policyResult, false) | ||
if err != nil { | ||
return fmt.Errorf(`failed to generate verification summary: %w`, err) | ||
} | ||
} else if err != nil { | ||
return fmt.Errorf("failed to verify policy: %w", err) | ||
} | ||
|
||
vo.VerificationSummary, err = verificationSummaryFromResults(vo.policyEnvelope, policyResult, true) | ||
if err != nil { | ||
return fmt.Errorf(`failed to generate verification summary: %w`, err) | ||
} | ||
return nil | ||
} | ||
|
||
func policyGitoid(policyBytes []byte) (cryptoutil.DigestSet, error) { | ||
return cryptoutil.CalculateDigestSetFromBytes(policyBytes, []crypto.Hash{crypto.SHA256}) | ||
} | ||
|
||
func verificationSummaryFromResults(policyEnvelope dsse.Envelope, policyResult policy.PolicyResult, accepted bool) (slsa.VerificationSummary, error) { | ||
inputAttestations := make([]slsa.ResourceDescriptor, len(policyResult.EvidenceByStep)) | ||
for _, input := range policyResult.EvidenceByStep { | ||
for _, attestation := range input { | ||
digest, err := policyGitoid(attestation.Envelope.Payload) | ||
if err != nil { | ||
log.Debugf("failed to calculate evidence hash: %v", err) | ||
continue | ||
} | ||
|
||
inputAttestations = append(inputAttestations, slsa.ResourceDescriptor{ | ||
URI: attestation.Reference, | ||
Digest: digest, | ||
}) | ||
} | ||
} | ||
|
||
policyDigest, err := policyGitoid(policyEnvelope.Payload) | ||
if err != nil { | ||
return slsa.VerificationSummary{}, fmt.Errorf("failed to calculate policy digest: %w", err) | ||
} | ||
|
||
verificationResult := slsa.FailedVerificationResult | ||
if accepted { | ||
verificationResult = slsa.PassedVerificationResult | ||
} | ||
|
||
return slsa.VerificationSummary{ | ||
Verifier: slsa.Verifier{ | ||
ID: "witness", | ||
}, | ||
TimeVerified: time.Now(), | ||
Policy: slsa.ResourceDescriptor{ | ||
URI: "", | ||
Digest: policyDigest, | ||
}, | ||
// ResourceURI: , | ||
InputAttestations: inputAttestations, | ||
VerificationResult: verificationResult, | ||
}, 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,60 @@ | ||
// Copyright 2023 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 verification | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestAttestorName(t *testing.T) { | ||
a := New() | ||
assert.Equal(t, a.Name(), "Expected Attestor Name Here") | ||
} | ||
|
||
func TestAttestorType(t *testing.T) { | ||
a := New() | ||
assert.Equal(t, a.Type(), "Expected Attestor Type Here") | ||
} | ||
|
||
func TestAttestorRunType(t *testing.T) { | ||
a := New() | ||
assert.Equal(t, a.RunType(), "Expected RunType Here") | ||
} | ||
|
||
func TestAttestorAttest(t *testing.T) { | ||
// Arrange | ||
a := New() | ||
ctx := "Replace with proper context creation" | ||
|
||
// Act | ||
err := a.Attest(ctx) | ||
Check failure on line 45 in attestation/verification/verification_test.go GitHub Actions / test (1.19.x, ubuntu-latest)
Check failure on line 45 in attestation/verification/verification_test.go GitHub Actions / test (1.19.x, ubuntu-latest)
|
||
|
||
// Assert | ||
require.NoError(t, err) | ||
} | ||
|
||
func TestYourFunctionHere(t *testing.T) { | ||
// Arrange | ||
// Setup variables here | ||
|
||
// Act | ||
// Perform function to be tested here | ||
|
||
// Assert | ||
// Assert whether the expected result and actual result match or not. | ||
} |
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,33 @@ | ||
package slsa | ||
|
||
import ( | ||
"time" | ||
|
||
"github.com/testifysec/go-witness/cryptoutil" | ||
) | ||
|
||
const ( | ||
VerificationSummaryPredicate = "https://slsa.dev/verification_summary/v1" | ||
PassedVerificationResult VerificationResult = "PASSED" | ||
FailedVerificationResult VerificationResult = "FAILED" | ||
) | ||
|
||
type VerificationResult string | ||
|
||
type Verifier struct { | ||
ID string `json:"id"` | ||
} | ||
|
||
type ResourceDescriptor struct { | ||
URI string `json:"uri"` | ||
Digest cryptoutil.DigestSet `json:"digest"` | ||
} | ||
|
||
type VerificationSummary struct { | ||
Verifier Verifier `json:"verifier"` | ||
TimeVerified time.Time `json:"timeVerified"` | ||
ResourceURI string `json:"resourceUri"` | ||
Policy ResourceDescriptor `json:"policy"` | ||
InputAttestations []ResourceDescriptor `json:"inputAttestations"` | ||
VerificationResult VerificationResult `json:"verificationResult"` | ||
} |
Oops, something went wrong.