This repository has been archived by the owner on Apr 9, 2024. It is now read-only.
Allow provenance-less endorsement generation #237
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -22,17 +22,19 @@ import ( | |||||
| "time" | ||||||
|
|
||||||
| "github.com/project-oak/transparent-release/internal/testutil" | ||||||
| "github.com/project-oak/transparent-release/pkg/claims" | ||||||
| prover "github.com/project-oak/transparent-release/pkg/proto/verification" | ||||||
| "google.golang.org/protobuf/encoding/prototext" | ||||||
| ) | ||||||
|
|
||||||
| const ( | ||||||
| binaryHash = "d059c38cea82047ad316a1c6c6fbd13ecf7a0abdcc375463920bd25bf5c142cc" | ||||||
|
There was a problem hiding this comment.
Suggested change
for consistency |
||||||
| binaryName = "oak_functions_freestanding_bin" | ||||||
| errorBinaryDigest = "does not match the given binary digest" | ||||||
| errorInconsistentProvenances = "provenances are not consistent" | ||||||
| ) | ||||||
|
|
||||||
| func TestGenerateEndorsement_SingleValidProvenance(t *testing.T) { | ||||||
| tomorrow := time.Now().AddDate(0, 0, 1) | ||||||
| nextWeek := time.Now().AddDate(0, 0, 7) | ||||||
| validity := claims.ClaimValidity{ | ||||||
|
|
@@ -50,12 +52,12 @@ func TestGenerateEndorsement_SingleValidEndorsement(t *testing.T) { | |||||
| t.Fatalf("Could not load provenances: %v", err) | ||||||
| } | ||||||
|
|
||||||
| verOpt, err := loadTextprotoVerificationOptions("../../testdata/reference_values.textproto") | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not load verification options: %v", err) | ||||||
| } | ||||||
|
|
||||||
| statement, err := GenerateEndorsement(binaryName, binaryHash, verOpt, validity, provenances) | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not generate endorsement from %q: %v", provenances[0].SourceMetadata.URI, err) | ||||||
| } | ||||||
|
|
@@ -69,7 +71,67 @@ func TestGenerateEndorsement_SingleValidEndorsement(t *testing.T) { | |||||
| testutil.AssertEq(t, "notAfter date", predicate.Validity.NotAfter, &nextWeek) | ||||||
| } | ||||||
|
|
||||||
| func TestGenerateEndorsement_NoProvenance(t *testing.T) { | ||||||
|
There was a problem hiding this comment. What happens if you give provenances and also set There was a problem hiding this comment. Added a few tests and updated the documentation on Let me know if you expect some other behavior. There was a problem hiding this comment. Hmmm... I am not sure I would expect "unverified provenances" as evidence, but actually: why not? However, is it clear afterwards if the provenances were verified? Or does that not really matter? There was a problem hiding this comment. They are not totally unverified. But they are not verified against a set of reference values. Actually this is similar to providing verification options with an empty
Currently we don't include the verification options in the endorsement, but I think it is a good idea to include it. As an extension. Created #238. |
||||||
| verOpts := &prover.VerificationOptions{ | ||||||
| // Skip verification to allow provenance-less endorsement generation. | ||||||
| Option: &prover.VerificationOptions_SkipProvenanceVerification{ | ||||||
| SkipProvenanceVerification: &prover.SkipVerification{}, | ||||||
| }, | ||||||
| } | ||||||
| tomorrow := time.Now().AddDate(0, 0, 1) | ||||||
| nextWeek := time.Now().AddDate(0, 0, 7) | ||||||
| validity := claims.ClaimValidity{ | ||||||
| NotBefore: &tomorrow, | ||||||
| NotAfter: &nextWeek, | ||||||
| } | ||||||
| statement, err := GenerateEndorsement(binaryName, binaryHash, verOpts, validity, []ParsedProvenance{}) | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not generate provenance-less endorsement: %v", err) | ||||||
| } | ||||||
|
|
||||||
| testutil.AssertEq(t, "binary hash", statement.Subject[0].Digest["sha256"], binaryHash) | ||||||
| testutil.AssertEq(t, "binary name", statement.Subject[0].Name, binaryName) | ||||||
|
|
||||||
| predicate := statement.Predicate.(claims.ClaimPredicate) | ||||||
|
|
||||||
| testutil.AssertEq(t, "notBefore date", predicate.Validity.NotBefore, &tomorrow) | ||||||
| testutil.AssertEq(t, "notAfter date", predicate.Validity.NotAfter, &nextWeek) | ||||||
|
|
||||||
| // Repeat the same with verification options loaded from file. | ||||||
| verOpts, err = loadTextprotoVerificationOptions("../../testdata/skip_verification.textproto") | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not load verification options: %v", err) | ||||||
| } | ||||||
| statement, err = GenerateEndorsement(binaryName, binaryHash, verOpts, validity, []ParsedProvenance{}) | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not generate provenance-less endorsement: %v", err) | ||||||
| } | ||||||
|
|
||||||
| testutil.AssertEq(t, "binary hash", statement.Subject[0].Digest["sha256"], binaryHash) | ||||||
| testutil.AssertEq(t, "binary name", statement.Subject[0].Name, binaryName) | ||||||
|
|
||||||
| predicate = statement.Predicate.(claims.ClaimPredicate) | ||||||
|
|
||||||
| testutil.AssertEq(t, "notBefore date", predicate.Validity.NotBefore, &tomorrow) | ||||||
| testutil.AssertEq(t, "notAfter date", predicate.Validity.NotAfter, &nextWeek) | ||||||
| } | ||||||
|
|
||||||
| func TestGenerateEndorsement_InvalidVerificationOptions(t *testing.T) { | ||||||
| tomorrow := time.Now().AddDate(0, 0, 1) | ||||||
| nextWeek := time.Now().AddDate(0, 0, 7) | ||||||
| validity := claims.ClaimValidity{ | ||||||
| NotBefore: &tomorrow, | ||||||
| NotAfter: &nextWeek, | ||||||
| } | ||||||
|
|
||||||
| verOpts := &prover.VerificationOptions{} | ||||||
| _, err := GenerateEndorsement(binaryName, binaryHash, verOpts, validity, []ParsedProvenance{}) | ||||||
| if err == nil || !strings.Contains(err.Error(), "invalid VerificationOptions") { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, "invalid VerificationOptions:") | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func TestLoadAndVerifyProvenances_MultipleValidProvenances(t *testing.T) { | ||||||
| tempPath1, err := copyToTemp("../../testdata/slsa_v02_provenance.json") | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not load provenance: %v", err) | ||||||
|
|
@@ -83,11 +145,12 @@ func TestLoadAndVerifyProvenances_MultipleValidEndorsement(t *testing.T) { | |||||
| t.Fatalf("Could not load provenances: %v", err) | ||||||
| } | ||||||
|
|
||||||
| verOpts := &prover.VerificationOptions{ | ||||||
| Option: &prover.VerificationOptions_ReferenceProvenance{ | ||||||
| ReferenceProvenance: &prover.ProvenanceReferenceValues{}, | ||||||
| }, | ||||||
| } | ||||||
| provenanceSet, err := verifyAndSummarizeProvenances(binaryName, binaryHash, verOpts, provenances) | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not generate endorsement from %q: %v", provenances[0].SourceMetadata.URI, err) | ||||||
| } | ||||||
|
|
@@ -114,12 +177,14 @@ func TestLoadAndVerifyProvenances_ConsistentNotVerified(t *testing.T) { | |||||
| if err != nil { | ||||||
| t.Fatalf("Could not load provenances: %v", err) | ||||||
| } | ||||||
| verOpts := &prover.VerificationOptions{ | ||||||
| Option: &prover.VerificationOptions_ReferenceProvenance{ | ||||||
| ReferenceProvenance: &prover.ProvenanceReferenceValues{}, | ||||||
| }, | ||||||
| } | ||||||
|
|
||||||
| // Provenances do not contain the given reference binary SHA256 digest value, but are consistent. | ||||||
| _, err = verifyAndSummarizeProvenances(binaryName, binaryHash+"_diff", verOpts, provenances) | ||||||
| if err == nil || !strings.Contains(err.Error(), errorBinaryDigest) { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, errorBinaryDigest) | ||||||
| } | ||||||
|
|
@@ -140,15 +205,16 @@ func TestLoadAndVerify_InconsistentVerified(t *testing.T) { | |||||
| if err != nil { | ||||||
| t.Fatalf("Could not load provenances: %v", err) | ||||||
| } | ||||||
| verOpt := prover.VerificationOptions{ | ||||||
| Option: &prover.VerificationOptions_ReferenceProvenance{ | ||||||
| ReferenceProvenance: &prover.ProvenanceReferenceValues{}, | ||||||
| }, | ||||||
| } | ||||||
|
|
||||||
| // Provenances each contain a (different) given reference binary SHA256 digest value, but are inconsistent. | ||||||
| _, err = verifyAndSummarizeProvenances(binaryName, binaryHash, &verOpt, provenances) | ||||||
| if err == nil || !strings.Contains(err.Error(), errorInconsistentProvenances) { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, errorInconsistentProvenances) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
|
|
@@ -167,18 +233,19 @@ func TestLoadAndVerify_InconsistentNotVerified(t *testing.T) { | |||||
| if err != nil { | ||||||
| t.Fatalf("Could not load provenances: %v", err) | ||||||
| } | ||||||
| verOpt := &prover.VerificationOptions{ | ||||||
| Option: &prover.VerificationOptions_ReferenceProvenance{ | ||||||
| ReferenceProvenance: &prover.ProvenanceReferenceValues{}, | ||||||
| }, | ||||||
| } | ||||||
|
|
||||||
| _, err = verifyAndSummarizeProvenances(binaryName, binaryHash+"_diff", verOpt, provenances) | ||||||
| if err == nil || !strings.Contains(err.Error(), errorBinaryDigest) { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, errorBinaryDigest) | ||||||
| } | ||||||
|
|
||||||
| if err == nil || !strings.Contains(err.Error(), errorInconsistentProvenances) { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, errorInconsistentProvenances) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
|
|
@@ -192,23 +259,17 @@ func TestLoadAndVerifyProvenances_NotVerified(t *testing.T) { | |||||
| if err != nil { | ||||||
| t.Fatalf("Could not load provenances: %v", err) | ||||||
| } | ||||||
| verOpts, err := loadTextprotoVerificationOptions("../../testdata/different_reference_values.textproto") | ||||||
| if err != nil { | ||||||
| t.Fatalf("Could not load verification options: %v", err) | ||||||
| } | ||||||
|
|
||||||
| _, err = verifyAndSummarizeProvenances(binaryName, "a_different_digest", verOpts, provenances) | ||||||
| if err == nil || !strings.Contains(err.Error(), errorBinaryDigest) { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, errorBinaryDigest) | ||||||
| } | ||||||
|
|
||||||
| want := "is different from the repo URI" | ||||||
| if err == nil || !strings.Contains(err.Error(), want) { | ||||||
| t.Fatalf("got %q, want error message containing %q,", err, want) | ||||||
| } | ||||||
|
|
@@ -234,3 +295,15 @@ func copyToTemp(path string) (string, error) { | |||||
|
|
||||||
| return tmpfile.Name(), nil | ||||||
| } | ||||||
|
|
||||||
| func loadTextprotoVerificationOptions(path string) (*prover.VerificationOptions, error) { | ||||||
| bytes, err := os.ReadFile(path) | ||||||
| if err != nil { | ||||||
| return nil, fmt.Errorf("reading provenance verification options from %q: %v", path, err) | ||||||
| } | ||||||
| var opt prover.VerificationOptions | ||||||
| if err := prototext.Unmarshal(bytes, &opt); err != nil { | ||||||
| return nil, fmt.Errorf("unmarshal bytes to VerificationOptions: %v", err) | ||||||
| } | ||||||
| return &opt, nil | ||||||
| } | ||||||
Oops, something went wrong.
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.
FYI this is mostly solved by bazel and / or nix. Especially since the instructions here refer to
latest, which will stop working at some point.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.
Thanks. We used to use bazel in this repo, and it caused a lot of problems. I think this is fine for now.