casbin-xorm-adapter

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

casbin-xorm-adapter

★ 382 Open GitHub ↗

Xorm adapter for Casbin

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Xorm Adapter

[![Go](https://github.com/apache/casbin-xorm-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/casbin-xorm-adapter/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/apache/casbin-xorm-adapter/badge.svg?branch=master)](https://coveralls.io/github/apache/casbin-xorm-adapter?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/apache/casbin-xorm-adapter)](https://goreportcard.com/report/github.com/apache/casbin-xorm-adapter)
[![Godoc](https://godoc.org/github.com/apache/casbin-xorm-adapter?status.svg)](https://godoc.org/github.com/apache/casbin-xorm-adapter)

Xorm Adapter is the [Xorm](https://gitea.com/xorm/xorm) adapter for [Casbin](https://github.com/casbin/casbin). With this library, Casbin can load policy from Xorm supported database or save policy to it.

Based on [Xorm Drivers Support](https://gitea.com/xorm/xorm#drivers-support), The current supported databases are:

- Mysql: [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
- MyMysql: [github.com/ziutek/mymysql](https://github.com/ziutek/mymysql/tree/master/godrv)
- Postgres: [github.com/lib/pq](https://github.com/lib/pq)
- Tidb: [github.com/pingcap/tidb](https://github.com/pingcap/tidb)
- SQLite: [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
- MsSql: [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
- Oracle: [github.com/mattn/go-oci8](https://github.com/mattn/go-oci8) (experiment)

## Installation

go get github.com/apache/casbin-xorm-adapter/v3

## Simple MySQL Example

```go
package main

import (
	"github.com/casbin/casbin/v2"
	_ "github.com/go-sql-driver/mysql"

"github.com/apache/casbin-xorm-adapter/v3"
)

func main() {
	// Initialize a Xorm adapter and use it in a Casbin enforcer:
	// The adapter will use the MySQL database named "casbin".
	// If it doesn't exist, the adapter will create it automatically.
	a, _ := xormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/") // Your driver and data source.

// Or you can use an existing DB "abc" like this:
	// The adapter will use the table named "casbin_rule".
	// If it doesn't exist, the adapter will create it automatically.
	// a := xormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/abc", true)

e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a)
	
	// Load the policy from DB.
	e.LoadPolicy()
	
	// Check the permission.
	e.Enforce("alice", "data1", "read")
	
	// Modify the policy.
	// e.AddPolicy(...)
	// e.RemovePolicy(...)
	
	// Save the policy back to DB.
	e.SavePolicy()
}
```

## Simple Postgres Example

```go
package main

import (
	"github.com/casbin/casbin/v2"
	_ "github.com/lib/pq"

"github.com/apache/casbin-xorm-adapter/v3"
)

func main() {
	// Initialize a Xorm adapter and use it in a Casbin enforcer:
	// The adapter will use the Postgres database named "casbin".
	// If it doesn't exist, the adapter will create it automatically.
	a, _ := xormadapter.NewAdapter("postgres", "user=postgres_username password=postgres_password host=127.0.0.1 port=5432 sslmode=disable") // Your driver and data source.

// Or you can use an existing DB "abc" like this:
	// The adapter will use the table named "casbin_rule".
	// If it doesn't exist, the adapter will create it automatically.
	// a := xormadapter.NewAdapter("postgres", "dbname=abc user=postgres_username password=postgres_password host=127.0.0.1 port=5432 sslmode=disable", true)

e, _ := casbin.NewEnforcer("../examples/rbac_model.conf", a)

// Load the policy from DB.
	e.LoadPolicy()

// Check the permission.
	e.Enforce("alice", "data1", "read")

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

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

## Context Adapter

`xormadapter` supports adapter with context, the following is a timeout control implemented using context

```go
a, _ := xormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/") // Your driver and data source. 
// Limited time 300s
ctx, cancel := context.WithTimeout(context.Background(), 300*time.Microsecond)
defer cancel()
err := a.AddPolicyCtx(ctx, "p", "p", []string{"alice", "data1", "read"})
if err != nil {
    panic(err)
}
```

## Getting Help

- [Casbin](https://github.com/casbin/casbin)

## License

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

casbin-xorm-adapter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README