authorization

README

authorization

基于casbin的gin权限验证中间件，定义好模型与策略文件后，可快速用于gin框架。

用法

import (
    "github.com/xmdas-link/authorization"
    gormadapter "github.com/casbin/gorm-adapter/v2"
)

route := gin.Default()

// 从策略文件加载策略规则
enforcer, _ = casbin.NewEnforcer("model.conf", "policy.csv")
route.Use(authorization.NewAuthorizer(enforcer, nil)) // 非多租户模式
route.Use(authorization.NewAuthorizer(enforcer, nil, true)) // 支持多租户模式

// 从数据库加载策略规则，动态加载更新策略
db, _ := gorm.Open("mysql", "root:123456@tcp(127.0.0.1:33306)/approval?parseTime=true&loc=Local")
adapter, _ := gormadapter.NewAdapterByDB(db)
enforcer, _ = casbin.NewEnforcer("model.conf", adapter)
// dynamic add policy
enforcer.AddPolicy("alice", "/school/list", "(GET)|(POST)", "allow")
enforcer.AddPolicy("user", "/school/add", "(GET)|(POST)", "allow")
// dynamic add group relationship
enforcer.AddGroupingPolicy("alice", "user")
enforcer.AddGroupingPolicy("bob", "user")
// reload policy from file/db
enforcer.LoadPolicy()

模型文件

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act, eft

[role_definition]
g = _, _

[policy_effect]
e = some(where (p.eft == allow)) && !some(where (p.eft == deny))

[matchers]
m = g(r.sub, p.sub) && keyMatch2(r.obj, p.obj) && regexMatch(r.act, p.act)

策略文件

p, user, /school/list, (GET)|(POST), allow
p, admin, /school/add, (GET)|(POST), allow
p, alice, /person/list, (GET)|(POST), allow
p, alice, /person/add, (GET)|(POST), allow
p, bob, /school/list, (GET)|(POST), deny

g, alice, admin
g, bob, admin
g, foo, user
g, admin, user

自定义从CONTEXT获取用户/角色/域方法

默认使用GIN的CONTEXT，用户/角色/域的默认KEY使用 auth组件定义
接口定义

type Authorizer interface {
	GetUserNameFromContext(context interface{}) string
	GetUserRoleFromContext(context interface{}) string
	GetUserDomainFromContext(context interface{}) string
}

只要实现Authorizer接口并传入authorization.NewAuthorizer(enforcer, nil) 第二个参数即可

Documentation

Index

• func NewAuthorizer(enforcer *casbin.Enforcer, a Authorizer, args ...bool) gin.HandlerFunc
• type Authorizer
• type BasicAuthorizer
  • func (authorize *BasicAuthorizer) CheckPermission(ctx *gin.Context) bool
  • func (authorize *BasicAuthorizer) GetUserDomain(ctx *gin.Context) string
  • func (authorize *BasicAuthorizer) GetUserName(ctx *gin.Context) string
  • func (authorize *BasicAuthorizer) GetUserRole(ctx *gin.Context) string
  • func (authorize *BasicAuthorizer) RequirePermission(ctx *gin.Context)
• type DefaultGinAuthorize
  • func (DefaultGinAuthorize) GetUserDomainFromContext(ctx interface{}) string
  • func (DefaultGinAuthorize) GetUserNameFromContext(ctx interface{}) string
  • func (DefaultGinAuthorize) GetUserRoleFromContext(ctx interface{}) string

Functions

func NewAuthorizer

func NewAuthorizer(enforcer *casbin.Enforcer, a Authorizer, args ...bool) gin.HandlerFunc

Types

type Authorizer

type Authorizer interface {
	GetUserNameFromContext(context interface{}) string
	GetUserRoleFromContext(context interface{}) string
	GetUserDomainFromContext(context interface{}) string
}

type BasicAuthorizer

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

func (*BasicAuthorizer) CheckPermission

func (authorize *BasicAuthorizer) CheckPermission(ctx *gin.Context) bool

func (*BasicAuthorizer) GetUserDomain

func (authorize *BasicAuthorizer) GetUserDomain(ctx *gin.Context) string

func (*BasicAuthorizer) GetUserName

func (authorize *BasicAuthorizer) GetUserName(ctx *gin.Context) string

func (*BasicAuthorizer) GetUserRole

func (authorize *BasicAuthorizer) GetUserRole(ctx *gin.Context) string

func (*BasicAuthorizer) RequirePermission

func (authorize *BasicAuthorizer) RequirePermission(ctx *gin.Context)

type DefaultGinAuthorize

type DefaultGinAuthorize struct {
}

func (DefaultGinAuthorize) GetUserDomainFromContext

func (DefaultGinAuthorize) GetUserDomainFromContext(ctx interface{}) string

func (DefaultGinAuthorize) GetUserNameFromContext

func (DefaultGinAuthorize) GetUserNameFromContext(ctx interface{}) string

func (DefaultGinAuthorize) GetUserRoleFromContext

func (DefaultGinAuthorize) GetUserRoleFromContext(ctx interface{}) string