Skip to content
This repository has been archived by the owner on Apr 9, 2024. It is now read-only.

Commit

Permalink
Use protobuf naming convention (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rbehjati
rbehjati committed Jul 21, 2023
1 parent 9fb29cf commit d9148f0
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 66 deletions.
4 changes: 2 additions & 2 deletions cmd/verifier/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (

"github.com/project-oak/transparent-release/internal/model"
"github.com/project-oak/transparent-release/internal/verifier"
prover "github.com/project-oak/transparent-release/pkg/proto/verification"
pb "github.com/project-oak/transparent-release/pkg/proto/verification"
)

func main() {
Expand All @@ -47,7 +47,7 @@ func main() {

provenanceVerifier := verifier.ProvenanceIRVerifier{
Got: provenanceIR,
Want: &prover.ProvenanceReferenceValues{},
Want: &pb.ProvenanceReferenceValues{},
}

if err := provenanceVerifier.Verify(); err != nil {
Expand Down
12 changes: 6 additions & 6 deletions internal/endorser/endorser.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import (
"github.com/project-oak/transparent-release/internal/verifier"
"github.com/project-oak/transparent-release/pkg/claims"
"github.com/project-oak/transparent-release/pkg/intoto"
prover "github.com/project-oak/transparent-release/pkg/proto/verification"
pb "github.com/project-oak/transparent-release/pkg/proto/verification"
)

// ParsedProvenance contains a provenance in the internal ProvenanceIR format,
Expand All @@ -57,7 +57,7 @@ type ParsedProvenance struct {
// provided, a provenance-less endorsement is generated, only if the input
// VerificationOptions has the EndorseProvenanceLess field set. An error is
// returned in all other cases.
func GenerateEndorsement(binaryName, binaryDigest string, verOpt *prover.VerificationOptions, validityDuration claims.ClaimValidity, provenances []ParsedProvenance) (*intoto.Statement, error) {
func GenerateEndorsement(binaryName, binaryDigest string, verOpt *pb.VerificationOptions, validityDuration claims.ClaimValidity, provenances []ParsedProvenance) (*intoto.Statement, error) {
if (verOpt.GetEndorseProvenanceLess() == nil) && (verOpt.GetReferenceProvenance() == nil) {
return nil, fmt.Errorf("invalid VerificationOptions: exactly one of EndorseProvenanceLess and ReferenceProvenance must be set")
}
Expand All @@ -77,7 +77,7 @@ func GenerateEndorsement(binaryName, binaryDigest string, verOpt *prover.Verific
// (2) Any of the provenances is invalid (see verifyProvenances for details),
// (3) Provenances do not match (e.g., have different binary names).
// (4) Provenances match but don't match the input binary name or digest.
func verifyAndSummarizeProvenances(binaryName, binaryDigest string, verOpt *prover.VerificationOptions, provenances []ParsedProvenance) (*claims.VerifiedProvenanceSet, error) {
func verifyAndSummarizeProvenances(binaryName, binaryDigest string, verOpt *pb.VerificationOptions, provenances []ParsedProvenance) (*claims.VerifiedProvenanceSet, error) {
if len(provenances) == 0 && verOpt.GetEndorseProvenanceLess() == nil {
return nil, fmt.Errorf("at least one provenance file must be provided")
}
Expand Down Expand Up @@ -120,7 +120,7 @@ func verifyAndSummarizeProvenances(binaryName, binaryDigest string, verOpt *prov
// ProvenanceReferenceValues. An error is returned if verification fails for
// one of them. No verification is performed if the provided
// ProvenanceReferenceValues is nil.
func verifyProvenances(referenceValues *prover.ProvenanceReferenceValues, provenances []model.ProvenanceIR) error {
func verifyProvenances(referenceValues *pb.ProvenanceReferenceValues, provenances []model.ProvenanceIR) error {
var errs error
if referenceValues == nil {
return nil
Expand Down Expand Up @@ -235,12 +235,12 @@ func GetProvenanceBytes(provenanceURI string) ([]byte, error) {

// LoadTextprotoVerificationOptions loads VerificationOptions from a .textproto
// file in the given path.
func LoadTextprotoVerificationOptions(path string) (*prover.VerificationOptions, error) {
func LoadTextprotoVerificationOptions(path string) (*pb.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
var opt pb.VerificationOptions
if err := prototext.Unmarshal(bytes, &opt); err != nil {
return nil, fmt.Errorf("unmarshal bytes to VerificationOptions: %v", err)
}
Expand Down
58 changes: 29 additions & 29 deletions internal/endorser/endorser_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (

"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"
pb "github.com/project-oak/transparent-release/pkg/proto/verification"
)

const (
Expand Down Expand Up @@ -59,18 +59,18 @@ func createProvenanceList(t *testing.T, paths []string) []ParsedProvenance {
}

func TestGenerateEndorsement_InvalidVerificationOptions(t *testing.T) {
verOpts := &prover.VerificationOptions{}
verOpts := &pb.VerificationOptions{}
_, err := GenerateEndorsement(binaryName, binaryDigestSha256, verOpts, createClaimValidity(7), []ParsedProvenance{})
if err == nil || !strings.Contains(err.Error(), "invalid VerificationOptions") {
t.Fatalf("got %q, want error message containing %q,", err, "invalid VerificationOptions:")
}
}

func TestGenerateEndorsement_NoProvenance_EndorseProvenanceLess(t *testing.T) {
verOpts := &prover.VerificationOptions{
verOpts := &pb.VerificationOptions{
// Allow provenance-less endorsement generation.
Option: &prover.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &prover.EndorseProvenanceLess{},
Option: &pb.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &pb.EndorseProvenanceLess{},
},
}
statement, err := GenerateEndorsement(binaryName, binaryDigestSha256, verOpts, createClaimValidity(7), []ParsedProvenance{})
Expand All @@ -96,9 +96,9 @@ func TestGenerateEndorsement_NoProvenance_EndorseProvenanceLess(t *testing.T) {
}

func TestGenerateEndorsement_SingleProvenance_EndorseProvenanceLess(t *testing.T) {
verOpts := &prover.VerificationOptions{
Option: &prover.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &prover.EndorseProvenanceLess{},
verOpts := &pb.VerificationOptions{
Option: &pb.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &pb.EndorseProvenanceLess{},
},
}
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json"})
Expand All @@ -116,9 +116,9 @@ func TestGenerateEndorsement_SingleProvenance_EndorseProvenanceLess(t *testing.T
}

func TestGenerateEndorsement_SingleInvalidProvenance_EndorseProvenanceLess(t *testing.T) {
verOpts := &prover.VerificationOptions{
Option: &prover.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &prover.EndorseProvenanceLess{},
verOpts := &pb.VerificationOptions{
Option: &pb.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &pb.EndorseProvenanceLess{},
},
}

Expand All @@ -132,9 +132,9 @@ func TestGenerateEndorsement_SingleInvalidProvenance_EndorseProvenanceLess(t *te

func TestLoadAndVerifyProvenances_MultipleValidProvenances_EndorseProvenanceLess(t *testing.T) {
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json", "../../testdata/slsa_v02_provenance.json"})
verOpts := &prover.VerificationOptions{
Option: &prover.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &prover.EndorseProvenanceLess{},
verOpts := &pb.VerificationOptions{
Option: &pb.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &pb.EndorseProvenanceLess{},
},
}
statement, err := GenerateEndorsement(binaryName, binaryDigestSha256, verOpts, createClaimValidity(7), provenances)
Expand All @@ -152,9 +152,9 @@ func TestLoadAndVerifyProvenances_MultipleValidProvenances_EndorseProvenanceLess
func TestLoadAndVerify_MultipleInconsistentProvenances_EndorseProvenanceLess(t *testing.T) {
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json", "../../testdata/different_slsa_v02_provenance.json"})

verOpts := &prover.VerificationOptions{
Option: &prover.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &prover.EndorseProvenanceLess{},
verOpts := &pb.VerificationOptions{
Option: &pb.VerificationOptions_EndorseProvenanceLess{
EndorseProvenanceLess: &pb.EndorseProvenanceLess{},
},
}

Expand Down Expand Up @@ -191,9 +191,9 @@ func TestGenerateEndorsement_SingleValidProvenance(t *testing.T) {
func TestLoadAndVerifyProvenances_MultipleValidProvenances(t *testing.T) {
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json", "../../testdata/slsa_v02_provenance.json"})

verOpts := &prover.VerificationOptions{
Option: &prover.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &prover.ProvenanceReferenceValues{},
verOpts := &pb.VerificationOptions{
Option: &pb.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &pb.ProvenanceReferenceValues{},
},
}
provenanceSet, err := verifyAndSummarizeProvenances(binaryName, binaryDigestSha256, verOpts, provenances)
Expand All @@ -216,9 +216,9 @@ func TestLoadProvenances_FailingSingleRemoteProvenanceEndorsement(t *testing.T)
func TestLoadAndVerifyProvenances_ConsistentNotVerified(t *testing.T) {
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json", "../../testdata/slsa_v02_provenance.json"})

verOpts := &prover.VerificationOptions{
Option: &prover.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &prover.ProvenanceReferenceValues{},
verOpts := &pb.VerificationOptions{
Option: &pb.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &pb.ProvenanceReferenceValues{},
},
}

Expand All @@ -232,9 +232,9 @@ func TestLoadAndVerifyProvenances_ConsistentNotVerified(t *testing.T) {
func TestLoadAndVerify_InconsistentVerified(t *testing.T) {
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json", "../../testdata/different_slsa_v02_provenance.json"})

verOpt := prover.VerificationOptions{
Option: &prover.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &prover.ProvenanceReferenceValues{},
verOpt := pb.VerificationOptions{
Option: &pb.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &pb.ProvenanceReferenceValues{},
},
}

Expand All @@ -248,9 +248,9 @@ func TestLoadAndVerify_InconsistentVerified(t *testing.T) {
func TestLoadAndVerify_InconsistentNotVerified(t *testing.T) {
provenances := createProvenanceList(t, []string{"../../testdata/slsa_v02_provenance.json", "../../testdata/different_slsa_v02_provenance.json"})

verOpt := &prover.VerificationOptions{
Option: &prover.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &prover.ProvenanceReferenceValues{},
verOpt := &pb.VerificationOptions{
Option: &pb.VerificationOptions_ReferenceProvenance{
ReferenceProvenance: &pb.ProvenanceReferenceValues{},
},
}

Expand Down
6 changes: 3 additions & 3 deletions internal/verifier/verifier.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ import (
"fmt"

"github.com/project-oak/transparent-release/internal/model"
prover "github.com/project-oak/transparent-release/pkg/proto/verification"
pb "github.com/project-oak/transparent-release/pkg/proto/verification"
"go.uber.org/multierr"
)

// ProvenanceIRVerifier verifies a provenance against a given reference, by verifying
// all non-empty fields in got using fields in the reference values. Empty fields will not be verified.
type ProvenanceIRVerifier struct {
Got *model.ProvenanceIR
Want *prover.ProvenanceReferenceValues
Want *pb.ProvenanceReferenceValues
}

// Verify verifies an instance of ProvenanceIRVerifier by comparing its Got and Want fields.
Expand Down Expand Up @@ -128,7 +128,7 @@ func (v *ProvenanceIRVerifier) verifyTrustedBuilder() error {
}

// verifySHA256Digest verifies that a given SHA256 is among the given digests.
func verifySHA256Digest(got string, want *prover.Digests) error {
func verifySHA256Digest(got string, want *pb.Digests) error {
if want == nil {
return nil
}
Expand Down
Loading

0 comments on commit d9148f0

Please sign in to comment.