diff options
| author | mo khan <mo@mokhan.ca> | 2025-07-23 11:50:42 -0600 |
|---|---|---|
| committer | mo khan <mo@mokhan.ca> | 2025-07-23 11:50:42 -0600 |
| commit | 944ef4ca499fe27a57d4cd3c21bccb99508526ca (patch) | |
| tree | 3c929141ee07fc2a4f2c2b825630cb2ad3121b44 | |
| parent | 8a1b03afb949a5a3be6a78e9b2c88d2e48643f46 (diff) | |
refactor: Update RequirePermission middleware to connect to spicedb CheckPermission API
| -rw-r--r-- | app/controllers/sparkles/controller.go | 2 | ||||
| -rw-r--r-- | app/domain/identifiable.go | 6 | ||||
| -rw-r--r-- | app/domain/sparkle.go | 8 | ||||
| -rw-r--r-- | app/domain/user.go | 13 | ||||
| -rw-r--r-- | app/init.go | 16 | ||||
| -rw-r--r-- | app/middleware/permission.go | 14 | ||||
| -rw-r--r-- | app/middleware/require_permission.go | 11 | ||||
| -rw-r--r-- | app/middleware/require_permission_test.go | 29 | ||||
| -rw-r--r-- | pkg/authz/grpc.go | 12 | ||||
| -rw-r--r-- | pkg/authz/spice.go | 26 |
10 files changed, 95 insertions, 42 deletions
diff --git a/app/controllers/sparkles/controller.go b/app/controllers/sparkles/controller.go index 0b86c7e..7e6975c 100644 --- a/app/controllers/sparkles/controller.go +++ b/app/controllers/sparkles/controller.go @@ -25,7 +25,7 @@ func (c *Controller) MountTo(mux *http.ServeMux) { mux.Handle("POST /sparkles", x.Middleware[http.Handler]( http.HandlerFunc(c.Create), middleware.RequireUser(), - // middleware.RequirePermission("create_sparkle", ioc.MustResolve[rpc.Ability](ioc.Default)), + // middleware.RequirePermission("create", x.Try(ioc.Resolve[authz.CheckPermission](ioc.Default))), )) // This is a temporary endpoint to restore a backup diff --git a/app/domain/identifiable.go b/app/domain/identifiable.go index 06bec07..190f20c 100644 --- a/app/domain/identifiable.go +++ b/app/domain/identifiable.go @@ -1,11 +1,15 @@ package domain -import "github.com/xlgmokha/x/pkg/x" +import ( + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" + "github.com/xlgmokha/x/pkg/x" +) type Identifiable interface { GetID() ID SetID(id ID) error ToGID() string + ToObjectReference() *v1.ObjectReference } func WithID[T Identifiable](id ID) x.Configure[T] { diff --git a/app/domain/sparkle.go b/app/domain/sparkle.go index d4f70b2..2ea5a53 100644 --- a/app/domain/sparkle.go +++ b/app/domain/sparkle.go @@ -4,6 +4,7 @@ import ( "errors" "regexp" + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/pkg/pls" ) @@ -53,6 +54,13 @@ func (s *Sparkle) ToGID() string { return "gid://sparkle/Sparkle/" + s.ID.String() } +func (self *Sparkle) ToObjectReference() *v1.ObjectReference { + return &v1.ObjectReference{ + ObjectType: "sparkle", + ObjectId: self.ID.String(), + } +} + func (s *Sparkle) Validate() error { if s.Sparklee == "" { return SparkleeIsRequired diff --git a/app/domain/user.go b/app/domain/user.go index 52cd780..88930c5 100644 --- a/app/domain/user.go +++ b/app/domain/user.go @@ -1,6 +1,9 @@ package domain -import "github.com/xlgmokha/x/pkg/x" +import ( + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" + "github.com/xlgmokha/x/pkg/x" +) type User struct { ID ID `json:"id" jsonapi:"primary,users"` @@ -37,3 +40,11 @@ func (self *User) Sparkle(sparklee string, reason string) *Sparkle { func (self *User) ToGID() string { return "gid://sparkle/User/" + self.ID.String() } + +func (self *User) ToObjectReference() *v1.ObjectReference { + // TODO:: Username is easy for demos but will need to change to ID + return &v1.ObjectReference{ + ObjectType: "user", + ObjectId: self.Username, + } +} diff --git a/app/init.go b/app/init.go index 5057fe4..53f9e66 100644 --- a/app/init.go +++ b/app/init.go @@ -1,19 +1,21 @@ package app import ( + "context" "net/http" "os" + "github.com/authzed/authzed-go/v1" "github.com/rs/zerolog" "github.com/xlgmokha/x/pkg/env" "github.com/xlgmokha/x/pkg/ioc" "github.com/xlgmokha/x/pkg/log" "github.com/xlgmokha/x/pkg/mapper" - "gitlab.com/gitlab-org/software-supply-chain-security/authorization/authzd.git/pkg/rpc" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/controllers/dashboard" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/controllers/sparkles" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/db" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/domain" + "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/pkg/authz" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/pkg/web" ) @@ -40,12 +42,16 @@ func init() { }, } }) - ioc.Register[rpc.Ability](ioc.Default, func() rpc.Ability { - return rpc.NewAbilityProtobufClient( - env.Fetch("AUTHZD_HOST", ""), - ioc.MustResolve[*http.Client](ioc.Default), + ioc.RegisterSingleton[*authzed.Client](ioc.Default, func() *authzed.Client { + return authz.NewSpiceDBClient( + context.Background(), + env.Fetch("ZED_ENDPOINT", ":50051"), + env.Fetch("ZED_TOKEN", "secret"), ) }) + ioc.Register[authz.CheckPermission](ioc.Default, func() authz.CheckPermission { + return ioc.MustResolve[*authzed.Client](ioc.Default) + }) http.DefaultClient = ioc.MustResolve[*http.Client](ioc.Default) diff --git a/app/middleware/permission.go b/app/middleware/permission.go index 03e7cf9..36a7ea0 100644 --- a/app/middleware/permission.go +++ b/app/middleware/permission.go @@ -1,7 +1,7 @@ package middleware import ( - "gitlab.com/gitlab-org/software-supply-chain-security/authorization/authzd.git/pkg/rpc" + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/domain" ) @@ -11,11 +11,13 @@ func (p Permission) ToGID() string { return "gid://sparkle/Permission/" + p.String() } -func (p Permission) RequestFor(user domain.Identifiable, resource domain.Identifiable) *rpc.AllowRequest { - return &rpc.AllowRequest{ - Subject: user.ToGID(), - Permission: p.ToGID(), - Resource: resource.ToGID(), +func (p Permission) RequestFor(user domain.Identifiable, resource domain.Identifiable) *v1.CheckPermissionRequest { + return &v1.CheckPermissionRequest{ + Subject: &v1.SubjectReference{ + Object: user.ToObjectReference(), + }, + Permission: p.String(), + Resource: resource.ToObjectReference(), } } diff --git a/app/middleware/require_permission.go b/app/middleware/require_permission.go index 563278e..a10a9b6 100644 --- a/app/middleware/require_permission.go +++ b/app/middleware/require_permission.go @@ -3,27 +3,26 @@ package middleware import ( "net/http" - "gitlab.com/gitlab-org/software-supply-chain-security/authorization/authzd.git/pkg/rpc" + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/cfg" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/domain" + "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/pkg/authz" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/pkg/pls" ) -func RequirePermission(permission Permission, ability rpc.Ability) func(http.Handler) http.Handler { +func RequirePermission(permission Permission, client authz.CheckPermission) func(http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { user := cfg.CurrentUser.From(r.Context()) - reply, err := ability.Allowed(r.Context(), - permission.RequestFor(user, &domain.Sparkle{ID: "*"}), - ) + reply, err := client.CheckPermission(r.Context(), permission.RequestFor(user, &domain.Sparkle{ID: "*"})) if err != nil { pls.LogError(r.Context(), err) w.WriteHeader(http.StatusForbidden) return } - if reply.Result { + if reply.Permissionship == v1.CheckPermissionResponse_PERMISSIONSHIP_HAS_PERMISSION { next.ServeHTTP(w, r) } else { w.WriteHeader(http.StatusForbidden) diff --git a/app/middleware/require_permission_test.go b/app/middleware/require_permission_test.go index 34a04a7..df21b5a 100644 --- a/app/middleware/require_permission_test.go +++ b/app/middleware/require_permission_test.go @@ -5,16 +5,17 @@ import ( "net/http" "testing" + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" "github.com/stretchr/testify/require" "github.com/xlgmokha/x/pkg/test" - "gitlab.com/gitlab-org/software-supply-chain-security/authorization/authzd.git/pkg/rpc" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/cfg" "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/app/domain" + "google.golang.org/grpc" ) -type MockAbility func(context.Context, *rpc.AllowRequest) (*rpc.AllowReply, error) +type MockAbility func(context.Context, *v1.CheckPermissionRequest) (*v1.CheckPermissionResponse, error) -func (m MockAbility) Allowed(ctx context.Context, r *rpc.AllowRequest) (*rpc.AllowReply, error) { +func (m MockAbility) CheckPermission(ctx context.Context, r *v1.CheckPermissionRequest, opts ...grpc.CallOption) (*v1.CheckPermissionResponse, error) { return m(ctx, r) } @@ -26,12 +27,18 @@ func TestRequirePermission(t *testing.T) { t.Run("when the permission is granted", func(t *testing.T) { r, w := test.RequestResponse("GET", "/sparkles", test.WithContext(ctx)) - middleware := RequirePermission(permission, MockAbility(func(ctx context.Context, r *rpc.AllowRequest) (*rpc.AllowReply, error) { - require.Equal(t, "gid://sparkle/User/"+user.ID.String(), r.Subject) - require.Equal(t, permission.ToGID(), r.Permission) - require.Equal(t, "gid://sparkle/Sparkle/*", r.Resource) + middleware := RequirePermission(permission, MockAbility(func(ctx context.Context, r *v1.CheckPermissionRequest) (*v1.CheckPermissionResponse, error) { + require.Equal(t, "user", r.Subject.Object.ObjectType) + require.Equal(t, user.Username, r.Subject.Object.ObjectId) - return &rpc.AllowReply{Result: true}, nil + require.Equal(t, permission.String(), r.Permission) + + require.Equal(t, "sparkle", r.Resource.ObjectType) + require.Equal(t, "*", r.Resource.ObjectId) + + return &v1.CheckPermissionResponse{ + Permissionship: v1.CheckPermissionResponse_PERMISSIONSHIP_HAS_PERMISSION, + }, nil })) server := middleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusTeapot) @@ -44,8 +51,10 @@ func TestRequirePermission(t *testing.T) { t.Run("when the permission is denied", func(t *testing.T) { r, w := test.RequestResponse("GET", "/sparkles", test.WithContext(ctx)) - middleware := RequirePermission(permission, MockAbility(func(ctx context.Context, r *rpc.AllowRequest) (*rpc.AllowReply, error) { - return &rpc.AllowReply{Result: false}, nil + middleware := RequirePermission(permission, MockAbility(func(ctx context.Context, r *v1.CheckPermissionRequest) (*v1.CheckPermissionResponse, error) { + return &v1.CheckPermissionResponse{ + Permissionship: v1.CheckPermissionResponse_PERMISSIONSHIP_NO_PERMISSION, + }, nil })) server := middleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { require.Fail(t, "unexpected call to handler") diff --git a/pkg/authz/grpc.go b/pkg/authz/grpc.go index 9851db4..ad5cc04 100644 --- a/pkg/authz/grpc.go +++ b/pkg/authz/grpc.go @@ -26,18 +26,6 @@ func NewGrpcConnection(ctx context.Context, host string) *grpc.ClientConn { return connection } -func NewSpiceDBClient(ctx context.Context, host string, presharedKey string) *authzed.Client { - client, err := authzed.NewClient( - host, - grpc.WithTransportCredentials(credentialsFor(ctx, host)), - grpc.WithPerRPCCredentials(NewBearerToken(presharedKey)), - ) - if err != nil { - pls.LogErrorNow(ctx, err) - } - return client -} - func credentialsFor(ctx context.Context, host string) credentials.TransportCredentials { if host == "" { return insecure.NewCredentials() diff --git a/pkg/authz/spice.go b/pkg/authz/spice.go new file mode 100644 index 0000000..a45a732 --- /dev/null +++ b/pkg/authz/spice.go @@ -0,0 +1,26 @@ +package authz + +import ( + "context" + + v1 "github.com/authzed/authzed-go/proto/authzed/api/v1" + "github.com/authzed/authzed-go/v1" + "gitlab.com/gitlab-org/software-supply-chain-security/authorization/sparkled/pkg/pls" + "google.golang.org/grpc" +) + +func NewSpiceDBClient(ctx context.Context, host string, presharedKey string) *authzed.Client { + client, err := authzed.NewClient( + host, + grpc.WithTransportCredentials(credentialsFor(ctx, host)), + grpc.WithPerRPCCredentials(NewBearerToken(presharedKey)), + ) + if err != nil { + pls.LogErrorNow(ctx, err) + } + return client +} + +type CheckPermission interface { + CheckPermission(ctx context.Context, in *v1.CheckPermissionRequest, opts ...grpc.CallOption) (*v1.CheckPermissionResponse, error) +} |
