Files
substrate/cmd/ateapi/internal/controlapi/validate.go
T
Haven Xia 7e339137cf ateapi: reject unknown fields on the request, not just the resource (#1216)
Fix #1213, we should also reject unknown fields at request level.

Refactor all functionality back into a gRPC interceptor to check every
incoming request, no need to handle every new request method.

> It's a good idea to open an issue first for discussion.

- [ ] Tests pass
- [ ] Appropriate changes to documentation are included in the PR
2026-08-26 16:56:05 -07:00

100 lines
3.6 KiB
Go

// Copyright 2026 Google LLC
//
// 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 controlapi
import (
"context"
"reflect"
"github.com/agent-substrate/substrate/pkg/proto/ateapipb"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
"k8s.io/apimachinery/pkg/api/operation"
"k8s.io/apimachinery/pkg/api/validate"
"k8s.io/apimachinery/pkg/util/validation"
"k8s.io/apimachinery/pkg/util/validation/field"
)
func toGRPCStatusError(errs field.ErrorList) error {
return status.Error(codes.InvalidArgument, errs.ToAggregate().Error())
}
func toGRPCInternalError(errs field.ErrorList) error {
return status.Error(codes.Internal, errs.ToAggregate().Error())
}
// scrubResourceMetadataForCreate removes fields that should not be set by the
// user when creating a resource.
func scrubResourceMetadataForCreate(in *ateapipb.ResourceMetadata) {
if in == nil {
return // validation will flag it
}
in.Uid = "" // will be set later
in.Version = 0 // will be set later
in.CreateTime = nil // will be set later
in.UpdateTime = nil // will be set later
}
// scrubResourceMetadataForUpdate removes fields that should not be set by the
// user when updating a resource.
func scrubResourceMetadataForUpdate(in *ateapipb.ResourceMetadata) {
if in == nil {
return // validation will flag it
}
// in.Uid and in.Version are preconditions, so we don't scrub them.
in.CreateTime = nil // will be set later
in.UpdateTime = nil // will be set later
}
// ateDeepEqual compares two values of any type, using proto.Equal if both are
// proto messages, and reflect.DeepEqual otherwise. This is called by
// declarative validation's generated code.
func ateDeepEqual[T any](a, b T) bool {
asProto := func(x any) proto.Message {
pm, ok := x.(proto.Message)
if !ok {
return nil
}
return pm
}
if pa, pb := asProto(a), asProto(b); pa != nil && pb != nil {
return proto.Equal(pa, pb)
}
return reflect.DeepEqual(a, b)
}
// This exists only because nested subfield tags are not supported yet.
func ValidateCustom_UpdateActorRequest_Actor(ctx context.Context, op operation.Operation, fldPath *field.Path, actor, _ *ateapipb.Actor) field.ErrorList {
if actor == nil || actor.Metadata == nil {
return nil // handled by DV
}
// Updates are validated in 2 steps: first the update request and then the
// resource itself. DV for the request doesn't descend into the resource
// metadata. Once DV supports nested subfield tags, this can be changed to
// something like:
// +k8s:subfield(metadata)=+k8s:subfield(atespace)=+k8s:required
errs := Validate_ResourceMetadata(ctx, op, fldPath.Child("metadata"), actor.Metadata, nil)
errs = append(errs, validate.RequiredValue(ctx, op, fldPath.Child("metadata", "atespace"), &actor.Metadata.Atespace, nil)...)
return errs
}
// This is needed because DV doesn't have a standard format for IP addresses yet.
func ValidateCustom_WorkerAssignment_WorkerPodIp(_ context.Context, _ operation.Operation, fldPath *field.Path, value, _ *string) field.ErrorList {
return validation.IsValidIP(fldPath, *value)
}