beegoormadapter

README

Beego ORM Adapter

Note: the last version that supports Beego v1 is: https://github.com/casbin/beego-orm-adapter/releases/tag/v2.0.2 . Beego v2 is supported starting from v3.0.0

Beego ORM Adapter is the Beego ORM adapter for Casbin. With this library, Casbin can load policy from Beego ORM supported database or save policy to it.

Based on Beego ORM Support, The current supported databases are:

• MySQL: github.com/go-sql-driver/mysql
• PostgreSQL: github.com/lib/pq
• Sqlite3: github.com/mattn/go-sqlite3

Installation

go get github.com/casbin/beego-orm-adapter/v2

Simple Example

package main

import (
    "log"

    beegoormadapter "github.com/casbin/beego-orm-adapter/v3"
    "github.com/casbin/casbin/v2"
    _ "github.com/go-sql-driver/mysql"
)

func main() {
    // Initialize a Beego ORM adapter and use it in a Casbin enforcer:
    a, err := beegoormadapter.NewAdapter("casbin", "mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/dbname") // Your driver and data source. 
    if err != nil {
        log.Fatalln(err)
    }

    e, err := casbin.NewEnforcer("examples/rbac_model.conf", a)
    if err != nil {
        log.Fatalln(err)
    }
    // Check the permission.
    e.Enforce("alice", "data1", "read")

    // Modify the policy.
    // e.AddPolicy(...)
    // e.RemovePolicy(...)

    // Save the policy back to DB.
    e.SavePolicy()
}

Custom Table Name

Beego ORM using TableNameI interface to customize the table name

reference: custom-table-name

You can customize the name of the table by NewAdapterWithTableName, and query the custom table name through GetFullTableName

func testCustomTableName(t *testing.T, a *Adapter, expectTableName string) {
    actualTableName := a.GetFullTableName()
    if actualTableName != expectTableName {
        t.Error("actual table name: ", a.GetFullTableName(), ", supposed to be ", expectTableName)
    }
}

func TestAdapterCustomTableName(t *testing.T) {
    a, err := NewAdapterWithTableName("customtablename", "mysql", "root:@tcp(127.0.0.1:3306)/casbin_test", "my_casbin", "prefix_")
    if err != nil {
        t.Fatal(err)
    }
    testCustomTableName(t, a, "prefix_my_casbin")
    testSaveLoad(t, a)
    testAutoSave(t, a)
}

Note: Currently, only one custom table name is supported, and no other table name should be used after the first use of NewAdapterWithTableName

Getting Help

• Casbin

License

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

Documentation

Index

• type Adapter
  • func NewAdapter(dataSourceAlias, driverName, dataSourceName string) (*Adapter, error)
  • func NewAdapterWithTableName(dataSourceAlias, driverName, dataSourceName, tableName, tablePrefix string) (*Adapter, error)
  • func (a *Adapter) AddPolicies(sec string, ptype string, rules [][]string) error
  • func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error
  • func (a *Adapter) GetFullTableName() string
  • func (a *Adapter) LoadPolicy(model model.Model) error
  • func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error
  • func (a *Adapter) RemovePolicies(sec string, ptype string, rules [][]string) error
  • func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error
  • func (a *Adapter) SavePolicy(model model.Model) error
• type CasbinRule
  • func (model *CasbinRule) TableName() string

Types

type Adapter

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

Adapter represents the Xorm adapter for policy storage.

func NewAdapter

func NewAdapter(dataSourceAlias, driverName, dataSourceName string) (*Adapter, error)

NewAdapter is the constructor for Adapter. dataSourceAlias: Database alias. ORM will use it to switch database. driverName: database driverName. dataSourceName: connection string

func NewAdapterWithTableName

func NewAdapterWithTableName(dataSourceAlias, driverName, dataSourceName, tableName, tablePrefix string) (*Adapter, error)

NewAdapterWithTableName is the constructor for Adapter. dataSourceAlias: Database alias. ORM will use it to switch database. driverName: database driverName. dataSourceName: connection string tableName: custom table name, if tableName=="" , adapter will use default tableName "casbin_rule". tablePrefix: using table prefix

func (*Adapter) AddPolicies

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

AddPolicies adds multiple policy rules to the storage.

func (*Adapter) AddPolicy

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

AddPolicy adds a policy rule to the storage.

func (*Adapter) GetFullTableName

func (a *Adapter) GetFullTableName() string

func (*Adapter) LoadPolicy

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

LoadPolicy loads policy from database.

func (*Adapter) RemoveFilteredPolicy

func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) 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) error

RemovePolicies removes multiple policy rules from the storage.

func (*Adapter) RemovePolicy

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

RemovePolicy removes a policy rule from the storage.

func (*Adapter) SavePolicy

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

SavePolicy saves policy to database.

type CasbinRule

type CasbinRule struct {
	Id    int
	Ptype string
	V0    string
	V1    string
	V2    string
	V3    string
	V4    string
	V5    string
	// contains filtered or unexported fields
}

func (*CasbinRule) TableName

func (model *CasbinRule) TableName() string

TableName Beego ORM using TableNameI interface to customize table name if tableName=="" , adapter will use default tableName "casbin_rule".