Documentation
¶
Index ¶
- func ActorRefFromActor(actor *auth.ActorContext) gate.ActorRef
- func ActorRefFromContext(ctx context.Context) (gate.ActorRef, bool)
- func ClaimsFromActor(actor *auth.ActorContext) gate.ActorClaims
- type ActorExtractor
- type ClaimsExtractor
- type ClaimsProvider
- type Option
- type PermConflictResolver
- type PermMapper
- type PermOption
- type PermissionFormatter
- type PermissionProvider
- type RoleMapper
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ActorRefFromActor ¶
func ActorRefFromActor(actor *auth.ActorContext) gate.ActorRef
ActorRefFromActor builds an ActorRef from an auth.ActorContext.
func ActorRefFromContext ¶
ActorRefFromContext extracts an ActorRef from context.
func ClaimsFromActor ¶ added in v0.28.0
func ClaimsFromActor(actor *auth.ActorContext) gate.ActorClaims
ClaimsFromActor builds ActorClaims from an auth.ActorContext using defaults.
Types ¶
type ActorExtractor ¶
type ActorExtractor func(context.Context) (*auth.ActorContext, bool)
ActorExtractor extracts an auth.ActorContext from context.
type ClaimsExtractor ¶ added in v0.28.0
type ClaimsExtractor func(context.Context) (*auth.ActorContext, bool)
ClaimsExtractor returns actor context to derive permissions.
type ClaimsProvider ¶ added in v0.28.0
type ClaimsProvider struct {
// contains filtered or unexported fields
}
ClaimsProvider derives feature claims from go-auth actor context.
func NewClaimsProvider ¶ added in v0.28.0
func NewClaimsProvider(opts ...Option) *ClaimsProvider
NewClaimsProvider builds a claims provider using go-auth's actor context extractor.
func (*ClaimsProvider) ClaimsFromContext ¶ added in v0.28.0
func (p *ClaimsProvider) ClaimsFromContext(ctx context.Context) (gate.ActorClaims, error)
ClaimsFromContext implements gate.ClaimsProvider.
type Option ¶
type Option func(*ClaimsProvider)
Option customizes ClaimsProvider behavior.
func WithActorExtractor ¶
func WithActorExtractor(extractor ActorExtractor) Option
WithActorExtractor overrides the actor context extractor.
func WithPermMapper ¶ added in v0.28.0
func WithPermMapper(mapper PermMapper) Option
WithPermMapper overrides the default permission mapper.
func WithPermissionFormatter ¶ added in v0.28.0
func WithPermissionFormatter(format PermissionFormatter) Option
WithPermissionFormatter customizes the resource/role permission formatter.
func WithRoleMapper ¶ added in v0.28.0
func WithRoleMapper(mapper RoleMapper) Option
WithRoleMapper overrides the default role mapper.
type PermConflictResolver ¶ added in v0.28.0
PermConflictResolver combines claims perms with derived perms.
type PermMapper ¶ added in v0.28.0
type PermMapper func(actor *auth.ActorContext) []string
PermMapper builds permission identifiers from ActorContext.
type PermOption ¶ added in v0.28.0
type PermOption func(*PermissionProvider)
PermOption customizes permission provider behavior.
func WithClaimsExtractor ¶ added in v0.28.0
func WithClaimsExtractor(extractor ClaimsExtractor) PermOption
WithClaimsExtractor overrides the claims extractor used to derive permissions.
func WithPermConflictResolver ¶ added in v0.28.0
func WithPermConflictResolver(resolver PermConflictResolver) PermOption
WithPermConflictResolver overrides how derived permissions are merged.
type PermissionFormatter ¶ added in v0.28.0
PermissionFormatter formats a resource/role pair into a permission string.
type PermissionProvider ¶ added in v0.28.0
type PermissionProvider struct {
// contains filtered or unexported fields
}
PermissionProvider derives permissions from claims and actor context.
func NewPermissionProvider ¶ added in v0.28.0
func NewPermissionProvider(opts ...PermOption) *PermissionProvider
NewPermissionProvider builds a permission provider using go-auth's actor context extractor.
func (*PermissionProvider) Permissions ¶ added in v0.28.0
func (p *PermissionProvider) Permissions(ctx context.Context, claims gate.ActorClaims) ([]string, error)
Permissions implements gate.PermissionProvider.
type RoleMapper ¶ added in v0.28.0
type RoleMapper func(actor *auth.ActorContext) []string
RoleMapper builds role identifiers from ActorContext.