Skip to content

Commit

Permalink
v2tenancy: make CE specific version of resource.Registration (#20681)
Browse files Browse the repository at this point in the history
  • Loading branch information
analogue authored Feb 20, 2024
1 parent 943426b commit 8ba919f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 33 deletions.
33 changes: 0 additions & 33 deletions internal/resource/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import (
"strings"
"sync"

"google.golang.org/protobuf/proto"

"github.com/hashicorp/consul/acl"
"github.com/hashicorp/consul/internal/storage"
"github.com/hashicorp/consul/proto-public/pbresource"
Expand Down Expand Up @@ -53,37 +51,6 @@ type ValidationHook func(*pbresource.Resource) error
// the data gets reencoded and stored back to the Data field.
type MutationHook func(*pbresource.Resource) error

type Registration struct {
// Type is the GVK of the resource type.
Type *pbresource.Type

// Proto is the resource's protobuf message type.
Proto proto.Message

// ACLs are hooks called to perform authorization on RPCs.
// The hooks can assume that Validate has been called.
ACLs *ACLHooks

// Validate is called to structurally validate the resource (e.g.
// check for required fields). Validate can assume that Mutate
// has been called.
Validate ValidationHook

// Mutate is called to fill out any autogenerated fields (e.g. UUIDs) or
// apply defaults before validation. Mutate can assume that
// Resource.ID is populated and has non-empty tenancy fields. This does
// not mean those tenancy fields actually exist.
Mutate MutationHook

// Scope describes the tenancy scope of a resource.
Scope Scope

// LicenseFeature is an optional enterprise license feature that the
// resource type is associated with. A string form of license.Feature
// from the consul-licensing module is expected.
LicenseFeature string
}

var ErrNeedResource = errors.New("authorization check requires the entire resource")

type ACLAuthorizeReadHook func(acl.Authorizer, *acl.AuthorizerContext, *pbresource.ID, *pbresource.Resource) error
Expand Down
38 changes: 38 additions & 0 deletions internal/resource/registry_ce.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

//go:build !consulent

package resource

import (
"google.golang.org/protobuf/proto"

"github.com/hashicorp/consul/proto-public/pbresource"
)

type Registration struct {
// Type is the GVK of the resource type.
Type *pbresource.Type

// Proto is the resource's protobuf message type.
Proto proto.Message

// ACLs are hooks called to perform authorization on RPCs.
// The hooks can assume that Validate has been called.
ACLs *ACLHooks

// Validate is called to structurally validate the resource (e.g.
// check for required fields). Validate can assume that Mutate
// has been called.
Validate ValidationHook

// Mutate is called to fill out any autogenerated fields (e.g. UUIDs) or
// apply defaults before validation. Mutate can assume that
// Resource.ID is populated and has non-empty tenancy fields. This does
// not mean those tenancy fields actually exist.
Mutate MutationHook

// Scope describes the tenancy scope of a resource.
Scope Scope
}

0 comments on commit 8ba919f

Please sign in to comment.