Files
probo/pkg/server/api/authz/authorization.go
Ludovic Vielle 3ebb221a9b Add OAuth2 API scope registration and enforcement
Register v1 API scopes in coredata, advertise them in OIDC discovery
and protected-resource metadata, show them on the consent screen, and
enforce scope-to-action mapping in the IAM Authorizer before policy
evaluation.

Signed-off-by: Ludovic Vielle <ludovic@probo.com>
2026-06-18 19:07:25 +02:00

193 lines
5.4 KiB
Go

// Copyright (c) 2026 Probo Inc <hello@probo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package authz
import (
"context"
"errors"
"go.gearno.de/kit/log"
"go.probo.inc/probo/pkg/coredata"
"go.probo.inc/probo/pkg/gid"
"go.probo.inc/probo/pkg/iam"
"go.probo.inc/probo/pkg/server/api/authn"
"go.probo.inc/probo/pkg/server/gqlutils"
)
type (
AuthorizeFuncOption func(*iam.AuthorizeParams)
AuthorizeFunc func(context.Context, gid.GID, iam.Action, ...AuthorizeFuncOption) (*coredata.Scope, error)
BatchAuthorizeFuncOption func(*iam.AuthorizeBatchParams)
BatchAuthorizeFunc func(context.Context, iam.Action, []gid.GID, ...BatchAuthorizeFuncOption) (*coredata.Scope, error)
)
func WithAttr(key, value string) AuthorizeFuncOption {
return func(params *iam.AuthorizeParams) {
params.ResourceAttributes[key] = value
}
}
// Use this option when it makes no sense to check whether the viewer is assuming the org of the accessed resource
// Example: on the viewer memberships page, we're accessing several organization names, but the viewer isn't assuming one yet.
func WithSkipAssumptionCheck() AuthorizeFuncOption {
return func(params *iam.AuthorizeParams) {
params.SkipAssumptionCheck = true
}
}
func WithDryRun() AuthorizeFuncOption {
return func(params *iam.AuthorizeParams) {
params.DryRun = true
}
}
func WithBatchAttr(key, value string) BatchAuthorizeFuncOption {
return func(params *iam.AuthorizeBatchParams) {
params.ResourceAttributes[key] = value
}
}
func WithBatchSkipAssumptionCheck() BatchAuthorizeFuncOption {
return func(params *iam.AuthorizeBatchParams) {
params.SkipAssumptionCheck = true
}
}
func WithBatchDryRun() BatchAuthorizeFuncOption {
return func(params *iam.AuthorizeBatchParams) {
params.DryRun = true
}
}
func NewAuthorizeFunc(
svc *iam.Service,
logger *log.Logger,
) AuthorizeFunc {
return func(
ctx context.Context,
objectID gid.GID,
action iam.Action,
options ...AuthorizeFuncOption,
) (*coredata.Scope, error) {
identity := authn.IdentityFromContext(ctx)
session := authn.SessionFromContext(ctx)
params := iam.AuthorizeParams{
Principal: identity.ID,
Resource: objectID,
Action: action,
ResourceAttributes: make(map[string]string),
}
if session != nil {
params.Session = &session.ID
}
for _, option := range options {
option(&params)
}
scope, err := svc.Authorizer.Authorize(ctx, params)
if err != nil {
if _, ok := errors.AsType[*iam.ErrAssumptionRequired](err); ok {
return nil, gqlutils.AssumptionRequired(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrInsufficientPermissions](err); ok {
return nil, gqlutils.Forbidden(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrInsufficientOAuth2Scope](err); ok {
return nil, gqlutils.Forbidden(ctx, err)
}
if errors.Is(err, coredata.ErrResourceNotFound) {
return nil, gqlutils.NotFoundf(ctx, "resource not found")
}
logger.ErrorCtx(ctx, "cannot authorize", log.Error(err))
return nil, gqlutils.Internal(ctx)
}
return scope, nil
}
}
func NewBatchAuthorizeFunc(
svc *iam.Service,
logger *log.Logger,
) BatchAuthorizeFunc {
return func(
ctx context.Context,
action iam.Action,
objectIDs []gid.GID,
options ...BatchAuthorizeFuncOption,
) (*coredata.Scope, error) {
identity := authn.IdentityFromContext(ctx)
session := authn.SessionFromContext(ctx)
params := iam.AuthorizeBatchParams{
Principal: identity.ID,
Action: action,
Resources: objectIDs,
ResourceAttributes: make(map[string]string),
}
if session != nil {
params.Session = &session.ID
}
for _, option := range options {
option(&params)
}
scope, err := svc.Authorizer.AuthorizeBatch(ctx, params)
if err != nil {
if _, ok := errors.AsType[*iam.ErrAssumptionRequired](err); ok {
return nil, gqlutils.AssumptionRequired(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrInsufficientPermissions](err); ok {
return nil, gqlutils.Forbidden(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrInsufficientOAuth2Scope](err); ok {
return nil, gqlutils.Forbidden(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrMixedOrganizationBatch](err); ok {
return nil, gqlutils.Invalid(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrEmptyResourceBatch](err); ok {
return nil, gqlutils.Invalid(ctx, err)
}
if _, ok := errors.AsType[*iam.ErrBatchAuthorizationUnsupportedResourceType](err); ok {
return nil, gqlutils.Invalid(ctx, err)
}
if errors.Is(err, coredata.ErrResourceNotFound) {
return nil, gqlutils.NotFoundf(ctx, "resource not found")
}
logger.ErrorCtx(ctx, "cannot batch authorize", log.Error(err))
return nil, gqlutils.Internal(ctx)
}
return scope, nil
}
}