Skip to content

Commit

Permalink
split out checker code
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Mason <[email protected]>
  • Loading branch information
mikemrm committed Jul 24, 2023
1 parent f702b7c commit 345e0aa
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 44 deletions.
54 changes: 54 additions & 0 deletions pkg/permissions/checker.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package permissions

import (
"context"

"github.com/labstack/echo/v4"
"go.infratographer.com/x/gidx"
)

var (
// CheckerCtxKey is the context key used to set the checker handling function
CheckerCtxKey = checkerCtxKey{}

// DefaultAllowChecker defaults to allow when checker is disabled or skipped
DefaultAllowChecker Checker = func(_ context.Context, _ gidx.PrefixedID, _ string) error {
return nil
}

// DefaultDenyChecker defaults to denied when checker is disabled or skipped
DefaultDenyChecker Checker = func(_ context.Context, _ gidx.PrefixedID, _ string) error {
return ErrPermissionDenied
}
)

// Checker defines the checker function definition
type Checker func(ctx context.Context, resource gidx.PrefixedID, action string) error

type checkerCtxKey struct{}

func setCheckerContext(c echo.Context, checker Checker) {
if checker == nil {
checker = DefaultDenyChecker
}

req := c.Request().WithContext(
context.WithValue(
c.Request().Context(),
CheckerCtxKey,
checker,
),
)

c.SetRequest(req)
}

// CheckAccess runs the checker function to check if the provided resource and action are supported.
func CheckAccess(ctx context.Context, resource gidx.PrefixedID, action string) error {
checker, ok := ctx.Value(CheckerCtxKey).(Checker)
if !ok {
return ErrCheckerNotFound
}

return checker(ctx, resource, action)
}
44 changes: 0 additions & 44 deletions pkg/permissions/permissions.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,6 @@ const (
)

var (
// CheckerCtxKey is the context key used to set the checker handling function
CheckerCtxKey = checkerCtxKey{}

// DefaultAllowChecker defaults to allow when checker is disabled or skipped
DefaultAllowChecker Checker = func(_ context.Context, _ gidx.PrefixedID, _ string) error {
return nil
}

// DefaultDenyChecker defaults to denied when checker is disabled or skipped
DefaultDenyChecker Checker = func(_ context.Context, _ gidx.PrefixedID, _ string) error {
return ErrPermissionDenied
}

defaultClient = &http.Client{
Timeout: defaultClientTimeout,
Transport: otelhttp.NewTransport(http.DefaultTransport),
Expand All @@ -48,11 +35,6 @@ var (
tracer = otel.GetTracerProvider().Tracer("go.infratographer.com/permissions-api/pkg/permissions")
)

// Checker defines the checker function definition
type Checker func(ctx context.Context, resource gidx.PrefixedID, action string) error

type checkerCtxKey struct{}

// Permissions handles supporting authorization checks
type Permissions struct {
enabled bool
Expand Down Expand Up @@ -191,22 +173,6 @@ func New(config Config, options ...Option) (*Permissions, error) {
return p, nil
}

func setCheckerContext(c echo.Context, checker Checker) {
if checker == nil {
checker = DefaultDenyChecker
}

req := c.Request().WithContext(
context.WithValue(
c.Request().Context(),
CheckerCtxKey,
checker,
),
)

c.SetRequest(req)
}

func ensureValidServerResponse(resp *http.Response) error {
if resp.StatusCode >= http.StatusMultiStatus {
if resp.StatusCode == http.StatusForbidden {
Expand All @@ -218,13 +184,3 @@ func ensureValidServerResponse(resp *http.Response) error {

return nil
}

// CheckAccess runs the checker function to check if the provided resource and action are supported.
func CheckAccess(ctx context.Context, resource gidx.PrefixedID, action string) error {
checker, ok := ctx.Value(CheckerCtxKey).(Checker)
if !ok {
return ErrCheckerNotFound
}

return checker(ctx, resource, action)
}

0 comments on commit 345e0aa

Please sign in to comment.