rbac

package module

Go to main page

Versions in this module

v0

v0.0.7

Mar 27, 2025

v0.0.6

Mar 26, 2025

v0.0.5

Mar 26, 2025

Changes in this version

type DefaultRole

+ func (r *DefaultRole) RePermissions(children bool) []*regexp.Regexp

type Role

+ RePermissions func(children bool) []*regexp.Regexp

v0.0.4

Nov 25, 2024

v0.0.3

Nov 21, 2024

Changes in this version

+ func WithRequestInfo(ctx context.Context, info RequestInfo) context.Context

+ type RequestInfo struct

+ Header http.Header

+ Host string

+ IsTLS bool

+ Method string

+ Pattern string

+ RemoteAddr string

+ RequestURI string

+ URL url.URL

+ func CtxRequestInfo(ctx context.Context) RequestInfo

v0.0.2

Nov 19, 2024

Changes in this version

+ func WithTarget(ctx context.Context, target *Target) context.Context

type Target

+ func CtxTarget(ctx context.Context) *Target

v0.0.1

Nov 19, 2024

Changes in this version

+ const DecisionAllow

+ const DecisionDeny

+ var ErrCircularReference = errors.New("circular reference detected")

+ var ErrDeny = errors.New("deny")

+ var ErrInvalidRole = errors.New("role must be a string or implement the Role interface")

+ var ErrRoleNotFound = errors.New("role not found")

+ func RequestAuthorizer(authorizer Authorizer, actions func(*http.Request) []string) func(*http.Request) error

+ func WithAssertions(ctx context.Context, assertions ...Assertion) context.Context

+ func WithClaims(ctx context.Context, claims *Claims) context.Context

+ type AccessConfig struct

+ Permissions []string

+ Role string

+ type Assertion interface

+ Assert func(ctx context.Context, role Role, permission string) (bool, error)

+ func CtxAssertions(ctx context.Context) []Assertion

+ type AssertionFunc func(ctx context.Context, role Role, permission string) (bool, error)

+ func (f AssertionFunc) Assert(ctx context.Context, role Role, permission string) (bool, error)

+ type AuthorizationChecker interface

+ IsGranted func(ctx context.Context, role any, permission string, assertions ...Assertion) bool

+ type Authorizer interface

+ Authorize func(ctx context.Context, claims *Claims, target *Target) (Decision, error)

+ type Claims struct

+ Metadata map[string]any

+ Subject Subject

+ func CtxClaims(ctx context.Context) *Claims

+ type Config struct

+ AccessControl []AccessConfig

+ CreateMissingRoles bool

+ RoleHierarchy []RoleConfig

+ type Decision int8

+ func (d Decision) String() string

+ type DefaultAuthorizer struct

+ func NewDefaultAuthorizer(rbac *RBAC) *DefaultAuthorizer

+ func (a *DefaultAuthorizer) Authorize(ctx context.Context, claims *Claims, target *Target) (d Decision, err error)

+ type DefaultRole struct

+ func NewRole(name string) *DefaultRole

+ func (r *DefaultRole) AddChild(child Role) error

+ func (r *DefaultRole) AddParent(parent Role) error

+ func (r *DefaultRole) AddPermissions(permission string, rest ...string)

+ func (r *DefaultRole) Children() []Role

+ func (r *DefaultRole) HasAncestor(role Role) bool

+ func (r *DefaultRole) HasDescendant(role Role) bool

+ func (r *DefaultRole) HasPermission(permission string) bool

+ func (r *DefaultRole) Name() string

+ func (r *DefaultRole) Parents() []Role

+ func (r *DefaultRole) Permissions(children bool) []string

+ func (r *DefaultRole) String() string

+ type RBAC struct

+ func New() *RBAC

+ func NewWithConfig(cfg Config) (*RBAC, error)

+ func (rbac *RBAC) AddRole(role any, parents ...any) error

+ func (rbac *RBAC) Apply(cfg Config) error

+ func (rbac *RBAC) CreateMissingRoles() bool

+ func (rbac *RBAC) HasRole(role any) (bool, error)

+ func (rbac *RBAC) IsGranted(ctx context.Context, role any, permission string, assertions ...Assertion) bool

+ func (rbac *RBAC) IsGrantedE(ctx context.Context, role any, permission string, assertions ...Assertion) (bool, error)

+ func (rbac *RBAC) Role(name string) (Role, error)

+ func (rbac *RBAC) Roles() []Role

+ func (rbac *RBAC) SetCreateMissingRoles(createMissingRoles bool) *RBAC

+ type Role interface

+ AddChild func(Role) error

+ AddParent func(Role) error

+ AddPermissions func(permission string, rest ...string)

+ Children func() []Role

+ HasAncestor func(role Role) bool

+ HasDescendant func(role Role) bool

+ HasPermission func(permission string) bool

+ Name func() string

+ Parents func() []Role

+ Permissions func(children bool) []string

+ type RoleConfig struct

+ Children []string

+ Parents []string

+ Role string

+ type Subject interface

+ Identifier func() string

+ Roles func() []string

+ type Target struct

+ Action string

+ Assertions []Assertion

+ Metadata map[string]any

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