authorizes

Documentation

Index

• func Access(handler miruken.Handler, action any, constraints ...any) (bool, *promise.Promise[bool], error)
• type AccessDeniedError
  • func (e *AccessDeniedError) Error() string
• type Builder
  • func (b *Builder) ForAction(action any) *Builder
  • func (b *Builder) New() *It
  • func (b *Builder) WithSubject(subject security.Subject) *Builder
• type It
  • func (a *It) Dispatch(handler any, greedy bool, composer miruken.Handler) miruken.HandleResult
  • func (a *It) Key() any
  • func (a *It) Policy() miruken.Policy
  • func (a *It) Source() any
  • func (a *It) String() string
• type Options
• type Required
  • func (r *Required) AppliesTo(callback miruken.Callback) bool
  • func (r *Required) Filters(binding miruken.Binding, callback any, composer miruken.Handler) ([]miruken.Filter, error)
  • func (r *Required) InitWithTag(tag reflect.StructTag) error
  • func (r *Required) Policy() any
  • func (r *Required) Required() bool

Functions

func Access

func Access(
	handler miruken.Handler,
	action any,
	constraints ...any,
) (bool, *promise.Promise[bool], error)

Access performs authorization on `action`.

Types

type AccessDeniedError

type AccessDeniedError struct {
	Action any
}

AccessDeniedError indicates authorization failed.

func (*AccessDeniedError) Error

func (e *AccessDeniedError) Error() string

type Builder

type Builder struct {
	miruken.CallbackBuilder
	// contains filtered or unexported fields
}

Builder builds It callbacks.

func (*Builder) ForAction

func (b *Builder) ForAction(
	action any,
) *Builder

func (*Builder) New

func (b *Builder) New() *It

func (*Builder) WithSubject

func (b *Builder) WithSubject(
	subject security.Subject,
) *Builder

type It

type It struct {
	miruken.CallbackBase
	// contains filtered or unexported fields
}

It authorizes callbacks contravariantly.

func (*It) Dispatch

func (a *It) Dispatch(
	handler any,
	greedy bool,
	composer miruken.Handler,
) miruken.HandleResult

func (*It) Key

func (a *It) Key() any

func (*It) Policy

func (a *It) Policy() miruken.Policy

func (*It) Source

func (a *It) Source() any

func (*It) String

func (a *It) String() string

type Options

type Options struct {
	RequirePolicy bool
}

Options control the authorization process.

type Required

type Required struct {
	// contains filtered or unexported fields
}

Required is a FilterProvider for authorization.

func (*Required) AppliesTo

func (r *Required) AppliesTo(
	callback miruken.Callback,
) bool

func (*Required) Filters

func (r *Required) Filters(
	binding miruken.Binding,
	callback any,
	composer miruken.Handler,
) ([]miruken.Filter, error)

func (*Required) InitWithTag

func (r *Required) InitWithTag(tag reflect.StructTag) error

func (*Required) Policy

func (r *Required) Policy() any

func (*Required) Required

func (r *Required) Required() bool