Skip to content

Fix gzip validation for UpdateApiSpec #628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 24, 2022
Merged

Fix gzip validation for UpdateApiSpec #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8245f37
Fix status codes for spec update errors
seaneganx Jun 23, 2022
4ec0e84
Add tests for create/update invalid gzip contents
seaneganx Jun 24, 2022
7119891
Fix MIME type check on spec updates
seaneganx Jun 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion server/registry/actions_specs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ func (s *RegistryServer) UpdateApiSpec(ctx context.Context, req *rpc.UpdateApiSp
// Apply the update to the spec - possibly changing the revision ID.
maskExpansion := models.ExpandMask(req.GetApiSpec(), req.GetUpdateMask())
if err := spec.Update(req.GetApiSpec(), maskExpansion); err != nil {
return nil, status.Error(codes.Internal, err.Error())
return nil, err
}

// Save the updated/current spec. This creates a new revision or updates the previous one.
Expand Down
30 changes: 30 additions & 0 deletions server/registry/actions_specs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,19 @@ func TestCreateApiSpecResponseCodes(t *testing.T) {
},
want: codes.InvalidArgument,
},
{
desc: "invalid contents for gzip mime type",
seed: &rpc.ApiVersion{Name: "projects/my-project/locations/global/apis/my-api/versions/v1"},
req: &rpc.CreateApiSpecRequest{
Parent: "projects/my-project/locations/global/apis/my-api/versions/v1",
ApiSpecId: "my-spec",
ApiSpec: &rpc.ApiSpec{
MimeType: "application/x.openapi+gzip",
Contents: []byte("these contents are not gzipped"),
},
},
want: codes.InvalidArgument,
},
}

for _, test := range tests {
Expand Down Expand Up @@ -1284,6 +1297,23 @@ func TestUpdateApiSpecResponseCodes(t *testing.T) {
},
want: codes.InvalidArgument,
},
{
desc: "invalid contents for gzip mime type",
seed: &rpc.ApiSpec{
Name: "projects/my-project/locations/global/apis/my-api/versions/v1/specs/my-spec",
MimeType: "application/x.openapi",
Contents: []byte("these contents are not gzipped"),
},
req: &rpc.UpdateApiSpecRequest{
ApiSpec: &rpc.ApiSpec{
Name: "projects/my-project/locations/global/apis/my-api/versions/v1/specs/my-spec",
MimeType: "application/x.openapi+gzip",
Contents: []byte("these contents are not gzipped"),
},
UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"contents", "mime_type"}},
},
want: codes.InvalidArgument,
},
}

for _, test := range tests {
Expand Down
35 changes: 22 additions & 13 deletions server/registry/internal/storage/models/spec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,44 +163,51 @@ func (s *Spec) BasicMessage(name string) (message *rpc.ApiSpec, err error) {
// Update modifies a spec using the contents of a message.
func (s *Spec) Update(message *rpc.ApiSpec, mask *fieldmaskpb.FieldMask) error {
s.RevisionUpdateTime = time.Now().Round(time.Microsecond)
var hasContents bool
for _, field := range mask.Paths {
switch field {
case "filename":
s.FileName = message.GetFilename()
case "description":
s.Description = message.GetDescription()
case "contents":
contents := message.GetContents()
// if contents are gzipped, uncompress before computing size and hash.
if strings.Contains(s.MimeType, "+gzip") && len(contents) > 0 {
var err error
contents, err = GUnzippedBytes(contents)
if err != nil {
return status.Error(codes.InvalidArgument, err.Error())
}
}
s.updateContents(contents)
hasContents = true
case "mime_type":
s.MimeType = message.GetMimeType()
case "source_uri":
s.SourceURI = message.GetSourceUri()
case "labels":
var err error
if s.Labels, err = bytesForMap(message.GetLabels()); err != nil {
return err
return status.Error(codes.Internal, err.Error())
}
case "annotations":
var err error
if s.Annotations, err = bytesForMap(message.GetAnnotations()); err != nil {
return err
return status.Error(codes.Internal, err.Error())
}
}
}

// Content updates depend on the current MIME type of the spec, so they
// should only happen after we update the MIME type field.
if hasContents {
return s.updateContents(message.GetContents())
}

return nil
}

func (s *Spec) updateContents(contents []byte) {
func (s *Spec) updateContents(contents []byte) error {
// Compute size and hash using uncompressed spec.
if strings.Contains(s.MimeType, "+gzip") && len(contents) > 0 {
var err error
contents, err = GUnzippedBytes(contents)
if err != nil {
return status.Error(codes.InvalidArgument, err.Error())
}
}

if hash := hashForBytes(contents); hash != s.Hash {
s.Hash = hash
s.RevisionID = newRevisionID()
Expand All @@ -210,6 +217,8 @@ func (s *Spec) updateContents(contents []byte) {
s.RevisionCreateTime = now
s.RevisionUpdateTime = now
}

return nil
}

// LabelsMap returns a map representation of stored labels.
Expand Down