authz

package

Go to main page

Versions in this module

v0

v0.4.0-beta.1

Nov 27, 2025

v0.3.1

Oct 22, 2025

v0.3.0

Oct 16, 2025

Changes in this version

+ func MarkScopeValidated(ctx context.Context) context.Context

+ func WasScopeValidated(ctx context.Context) bool

+ type AuditLogger func(ctx context.Context, decision AuthzDecision)

+ type AuthzDecision struct

+ Action Action

+ DefaultEffect Effect

+ Effect Effect

+ EvaluatedPolicies []PolicyEvaluation

+ Identity auth.Identity

+ ObjectID any

+ Reason string

+ Resource string

+ Roles []Role

+ Scope Scope

+ ScopeValidated bool

type AuthzOption

+ func WithAuditLogger(logger AuditLogger) AuthzOption

+ type PolicyEvaluation struct

+ Effect Effect

+ Role Role

type RoleDescriber

+ func Compose[T any](describers ...TypedRoleDescriber[T]) RoleDescriber

type TypedObjectFetcher

+ func ComposeFetchers[K comparable, T any](fetchers ...TypedObjectFetcher[K, T]) TypedObjectFetcher[K, T]

+ func DefaultFetcher[K comparable, T any](fetcher TypedObjectFetcher[K, T], defaultValue T) TypedObjectFetcher[K, T]

+ func Fetcher[K comparable, T any](fetch func(context.Context, K) (T, error)) TypedObjectFetcher[K, T]

+ func MapFetcher[K comparable, T any](m map[K]T) TypedObjectFetcher[K, T]

+ func TransformKey[K1, K2 comparable, T any](transform func(K1) K2, fetcher TypedObjectFetcher[K2, T]) TypedObjectFetcher[K1, T]

+ func ValidatedFetcher[K comparable, T any](fetcher TypedObjectFetcher[K, T], validate func(T) error) TypedObjectFetcher[K, T]

type TypedRoleDescriber

+ func ConditionalRole[T any](role Role, ...) TypedRoleDescriber[T]

+ func GlobalRole[T any](role Role, predicate func(context.Context) bool) TypedRoleDescriber[T]

+ func IdentityOwnershipRole[T any](role Role, ...) TypedRoleDescriber[T]

+ func MembershipRoles[T any](getScopeID func(T) string, ...) TypedRoleDescriber[T]

+ func OwnershipRole[T any](role Role, getOwnerID func(T) string) TypedRoleDescriber[T]

+ func StaticRole[T any](role Role, predicate func(context.Context, auth.Identity, T, Scope) bool) TypedRoleDescriber[T]

+ func StaticRoles[T any](getRoles func(context.Context, auth.Identity, T, Scope) []Role) TypedRoleDescriber[T]

+ func ValidateScope[T any](describer TypedRoleDescriber[T]) TypedRoleDescriber[T]

v0.3.0-beta.2

Oct 6, 2025

v0.3.0-beta.1

Oct 6, 2025

v0.3.0-beta.0

Oct 5, 2025

v0.2.2

May 16, 2025

v0.2.1

May 9, 2025

v0.2.0

Mar 28, 2025

Changes in this version

+ const ActionCreate

+ const ActionDelete

+ const ActionList

+ const ActionRead

+ const ActionUpdate

+ const RoleAdmin

+ const RoleEditor

+ const RoleOwner

+ const RoleUser

+ const RoleViewer

+ var E_Scope = &file_plugins_authz_authz_proto_extTypes[5]

type AuthorizeParams

+ Scope Scope

+ type AuthzObject interface

+ AuthzType func() string

type AuthzOption

+ func WithObjectFetcherFn(objectKey string, fetcher func(ctx context.Context, key any) (any, error)) AuthzOption

+ func WithRoleDescriberFn(objectKey string, ...) AuthzOption

+ func WithTypeRegistration[K comparable, T any](objectKey string, fetcher TypedObjectFetcher[K, T], ...) AuthzOption

+ func WithTypedObjectFetcher[K comparable, T any](objectKey string, fetcher TypedObjectFetcher[K, T]) AuthzOption

+ func WithTypedRoleDescriber[T any](objectKey string, describer TypedRoleDescriber[T]) AuthzOption

+ type Builder struct

+ func NewBuilder() *Builder

+ func NewCommonBuilder() *Builder

+ func (b *Builder) Build() *AuthzPlugin

+ func (b *Builder) WithObjectFetcher(objectKey string, fetcher ObjectFetcher) *Builder

+ func (b *Builder) WithObjectFetcherFn(objectKey string, fetcher func(ctx context.Context, key any) (any, error)) *Builder

+ func (b *Builder) WithPolicy(effect Effect, role Role, action Action) *Builder

+ func (b *Builder) WithRoleDescriber(objectKey string, describer RoleDescriber) *Builder

+ func (b *Builder) WithRoleDescriberFn(objectKey string, ...) *Builder

+ func (b *Builder) WithRoleHierarchy(roles ...Role) *Builder

+ func (b *Builder) WithTypedObjectFetcher(objectKey string, fetcher interface{}) *Builder

+ func (b *Builder) WithTypedRoleDescriber(objectKey string, describer interface{}) *Builder

type ObjectFetcher

+ func AsObjectFetcher[K comparable, T any](fetcher TypedObjectFetcher[K, T]) ObjectFetcher

+ FetchObject func(ctx context.Context, key any) (any, error)

+ type ObjectFetcherFn func(ctx context.Context, key any) (any, error)

+ func (f ObjectFetcherFn) FetchObject(ctx context.Context, key any) (any, error)

+ type OwnedObject interface

+ OwnerID func() string

type RoleDescriber

+ func AsRoleDescriber[T any](describer TypedRoleDescriber[T]) RoleDescriber

+ DescribeRoles func(ctx context.Context, subject auth.Identity, object any, scope Scope) ([]Role, error)

+ type RoleDescriberFn func(ctx context.Context, subject auth.Identity, object any, scope Scope) ([]Role, error)

+ func (f RoleDescriberFn) DescribeRoles(ctx context.Context, subject auth.Identity, object any, scope Scope) ([]Role, error)

+ type Scope string

+ type ScopedObject interface

+ ScopeID func() string

+ type TypedBuilder struct

+ func NewTypedBuilder[T any]() *TypedBuilder[T]

+ func (tb *TypedBuilder[T]) Build() *AuthzPlugin

+ func (tb *TypedBuilder[T]) WithIntObjectFetcher(objectKey string, fetcher func(ctx context.Context, key int) (T, error)) *TypedBuilder[T]

+ func (tb *TypedBuilder[T]) WithPolicy(effect Effect, role Role, action Action) *TypedBuilder[T]

+ func (tb *TypedBuilder[T]) WithRoleDescriber(objectKey string, ...) *TypedBuilder[T]

+ func (tb *TypedBuilder[T]) WithRoleHierarchy(roles ...Role) *TypedBuilder[T]

+ func (tb *TypedBuilder[T]) WithStringObjectFetcher(objectKey string, fetcher func(ctx context.Context, key string) (T, error)) *TypedBuilder[T]

+ type TypedObjectFetcher func(ctx context.Context, key K) (T, error)

+ type TypedRoleDescriber func(ctx context.Context, subject auth.Identity, object T, scope Scope) ([]Role, error)

v0.1.1

Feb 6, 2025

Changes in this version

+ const PluginName

+ var E_Action = &file_plugins_authz_authz_proto_extTypes[0]

+ var E_DefaultEffect = &file_plugins_authz_authz_proto_extTypes[2]

+ var E_Domain = &file_plugins_authz_authz_proto_extTypes[4]

+ var E_Id = &file_plugins_authz_authz_proto_extTypes[3]

+ var E_Resource = &file_plugins_authz_authz_proto_extTypes[1]

+ var ErrPermissionDenied = errors.Codef(codes.PermissionDenied, "you are not authorized to perform this action")

+ var ErrUnauthenticated = errors.Codef(codes.Unauthenticated, "the requested action requires authentication")

+ var File_plugins_authz_authz_proto protoreflect.FileDescriptor

+ func FieldOptions(req proto.Message) (any, string, error)

+ func MethodOptions(info *grpc.UnaryServerInfo) (objectKey string, action Action, defaultEffect Effect)

+ type Action string

+ type AuthorizeParams struct

+ Action Action

+ DefaultEffect Effect

+ Domain string

+ Info string

+ ObjectID any

+ ObjectKey string

+ type AuthzOption func(*AuthzPlugin)

+ func WithObjectFetcher(objectKey string, fn ObjectFetcher) AuthzOption

+ func WithPolicy(effect Effect, role Role, action Action) AuthzOption

+ func WithRoleDescriber(objectKey string, fn RoleDescriber) AuthzOption

+ func WithRoleHierarchy(roles ...Role) AuthzOption

+ type AuthzPlugin struct

+ func Plugin(opts ...AuthzOption) *AuthzPlugin

+ func (ap *AuthzPlugin) Authorize(ctx context.Context, cfg AuthorizeParams) error

+ func (ap *AuthzPlugin) DebugHandler(resp http.ResponseWriter, req *http.Request)

+ func (ap *AuthzPlugin) DefinePolicy(effect Effect, role Role, action Action)

+ func (ap *AuthzPlugin) Deps() []string

+ func (ap *AuthzPlugin) DetermineEffect(action Action, roles []Role, defaultEffect Effect) Effect

+ func (ap *AuthzPlugin) Interceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (resp interface{}, err error)

+ func (ap *AuthzPlugin) Name() string

+ func (ap *AuthzPlugin) RegisterObjectFetcher(objectKey string, fn ObjectFetcher)

+ func (ap *AuthzPlugin) RegisterRoleDescriber(objectKey string, fn RoleDescriber)

+ func (ap *AuthzPlugin) RoleHierarchy(role Role) []Role

+ func (ap *AuthzPlugin) RoleTree() map[Role][]Role

+ func (ap *AuthzPlugin) ServerOptions() []prefab.ServerOption

+ func (ap *AuthzPlugin) SetRoleHierarchy(roles ...Role)

+ type Domain string

+ type Effect int

+ const Allow

+ const Deny

+ func (e Effect) Reverse() Effect

+ func (e Effect) String() string

+ type ObjectFetcher func(ctx context.Context, key any) (any, error)

+ type Role string

+ type RoleDescriber func(ctx context.Context, subject auth.Identity, object any, domain Domain) ([]Role, error)

v0.1.0

Feb 5, 2025

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL