authz

Documentation

Index

• func SetAdapter(adapter persist.Adapter)
• func SetDefaultAuthorization(au *Authorization)
• type Authorization
  • func NewAuthorization(cnf *conf.Configuration, opts ...Option) (au *Authorization, err error)
  • func (au *Authorization) BaseEnforcer() *casbin.Enforcer
  • func (au *Authorization) CheckPermission(ctx context.Context, identity security.Identity, item *security.PermissionItem) (bool, error)
• type Option
  • func WithRequestParseFunc(f RequestParserFunc) Option
• type RequestParserFunc

Functions

func SetAdapter

func SetAdapter(adapter persist.Adapter)

SetAdapter sets the default adapter for the enforcer.

func SetDefaultAuthorization

func SetDefaultAuthorization(au *Authorization)

SetDefaultAuthorization sets the default authorization.

Types

type Authorization

type Authorization struct {
	Enforcer casbin.IEnforcer

	Watcher persist.Watcher
	// RequestParser is the function to parse cashbin request according cashbin Model
	RequestParser RequestParserFunc
	// contains filtered or unexported fields
}

Authorization is an Authorization feature base on casbin.

var (
	DefaultAuthorization *Authorization
)

func NewAuthorization

func NewAuthorization(cnf *conf.Configuration, opts ...Option) (au *Authorization, err error)

NewAuthorization returns a new authenticator with CachedEnforcer and redis watcher by application configuration. Configuration example:

  authz:
    autoSave: false
	   expireTime: 1h
	   watcherOptions:
	     options:
	       addr: "localhost:6379"
	       channel: "/casbin"
	   model: /path/to/model.conf
	   policy: /path/to/policy.csv

func (*Authorization) BaseEnforcer

func (au *Authorization) BaseEnforcer() *casbin.Enforcer

BaseEnforcer returns the base enforcer. casbin api is not broadcasting to enforcer interface. so need to use base enforcer.

func (*Authorization) CheckPermission

func (au *Authorization) CheckPermission(ctx context.Context, identity security.Identity, item *security.PermissionItem) (bool, error)

type Option

type Option func(*Authorization)

func WithRequestParseFunc

func WithRequestParseFunc(f RequestParserFunc) Option

WithRequestParseFunc set the request parser function.

type RequestParserFunc

type RequestParserFunc func(ctx context.Context, identity security.Identity, item *security.PermissionItem) []any