adapter

README

gf-adapter

GF ORM adapter for Casbin.

Tested in:

• MySQL

Installation

go get github.com/zcyc/gf-adapter/v2
go mod tidy

Usage example

a, _ := NewAdapter(context.Background(), gdb.DefaultGroupName, "", nil)

Notice

you should create the database on your own.

Getting Help

• Casbin

License

This project is under Apache 2.0 License. See the LICENSE file for the full license text.

Documentation

Index

• Variables
• type Adapter
  • func NewAdapter(ctx context.Context, dbGroupName, tableName string, db gdb.DB) (adp *Adapter, err error)
  • func (a *Adapter) AddPolicies(sec string, pType string, rules [][]string) (err error)
  • func (a *Adapter) AddPolicy(sec string, pType string, rule []string) (err error)
  • func (a *Adapter) IsFiltered() bool
  • func (a *Adapter) LoadFilteredPolicy(model model.Model, filter interface{}) error
  • func (a *Adapter) LoadPolicy(model model.Model) (err error)
  • func (a *Adapter) RemoveFilteredPolicy(sec string, pType string, fieldIndex int, fieldValues ...string) (err error)
  • func (a *Adapter) RemovePolicies(sec string, pType string, rules [][]string) (err error)
  • func (a *Adapter) RemovePolicy(sec string, pType string, rule []string) (err error)
  • func (a *Adapter) SavePolicy(model model.Model) (err error)
  • func (a *Adapter) UpdateFilteredPolicies(sec string, pType string, newPolicies [][]string, fieldIndex int, ...) ([][]string, error)
  • func (a *Adapter) UpdatePolicies(sec string, pType string, oldRules, newRules [][]string) (err error)
  • func (a *Adapter) UpdatePolicy(sec string, pType string, oldRule, newRule []string) (err error)
• type Filter
• type Rule

Variables

var (
	Columns = Rule{
		PType: "p_type",
		V0:    "v0",
		V1:    "v1",
		V2:    "v2",
		V3:    "v3",
		V4:    "v4",
		V5:    "v5",
	}
)

Types

type Adapter

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

func NewAdapter

func NewAdapter(ctx context.Context, dbGroupName, tableName string, db gdb.DB) (adp *Adapter, err error)

NewAdapter Create a casbin adapter

func (*Adapter) AddPolicies

func (a *Adapter) AddPolicies(sec string, pType string, rules [][]string) (err error)

AddPolicies adds policy rules to the storage.

func (*Adapter) AddPolicy

func (a *Adapter) AddPolicy(sec string, pType string, rule []string) (err error)

AddPolicy adds a policy rule to the storage.

func (*Adapter) IsFiltered

func (a *Adapter) IsFiltered() bool

IsFiltered returns true if the loaded policy has been filtered.

func (*Adapter) LoadFilteredPolicy

func (a *Adapter) LoadFilteredPolicy(model model.Model, filter interface{}) error

LoadFilteredPolicy loads only policy rules that match the filter.

func (*Adapter) LoadPolicy

func (a *Adapter) LoadPolicy(model model.Model) (err error)

LoadPolicy loads all policy rules from the storage.

func (*Adapter) RemoveFilteredPolicy

func (a *Adapter) RemoveFilteredPolicy(sec string, pType string, fieldIndex int, fieldValues ...string) (err error)

RemoveFilteredPolicy removes policy rules that match the filter from the storage.

func (*Adapter) RemovePolicies

func (a *Adapter) RemovePolicies(sec string, pType string, rules [][]string) (err error)

RemovePolicies removes policy rules from the storage (implements the persist.BatchAdapter interface).

func (*Adapter) RemovePolicy

func (a *Adapter) RemovePolicy(sec string, pType string, rule []string) (err error)

RemovePolicy removes a policy rule from the storage.

func (*Adapter) SavePolicy

func (a *Adapter) SavePolicy(model model.Model) (err error)

SavePolicy Saves all policy rules to the storage.

func (*Adapter) UpdateFilteredPolicies

func (a *Adapter) UpdateFilteredPolicies(sec string, pType string, newPolicies [][]string, fieldIndex int, fieldValues ...string) ([][]string, error)

UpdateFilteredPolicies deletes old rules and adds new rules.

func (*Adapter) UpdatePolicies

func (a *Adapter) UpdatePolicies(sec string, pType string, oldRules, newRules [][]string) (err error)

UpdatePolicies updates some policy rules to storage, like db, redis.

func (*Adapter) UpdatePolicy

func (a *Adapter) UpdatePolicy(sec string, pType string, oldRule, newRule []string) (err error)

UpdatePolicy updates a policy rule from storage.

type Filter

type Filter struct {
	PType []string
	V0    []string
	V1    []string
	V2    []string
	V3    []string
	V4    []string
	V5    []string
}

type Rule

type Rule struct {
	PType string `orm:"p_type" json:"p_type"`
	V0    string `orm:"v0" json:"v0"`
	V1    string `orm:"v1" json:"v1"`
	V2    string `orm:"v2" json:"v2"`
	V3    string `orm:"v3" json:"v3"`
	V4    string `orm:"v4" json:"v4"`
	V5    string `orm:"v5" json:"v5"`
}