https://github.com/casbin/casbin-pg-adapter
A go-pg adapter for casbin
https://github.com/casbin/casbin-pg-adapter
access-control adapter casbin go go-pg golang pg
Last synced: about 1 month ago
JSON representation
A go-pg adapter for casbin
- Host: GitHub
- URL: https://github.com/casbin/casbin-pg-adapter
- Owner: casbin
- License: apache-2.0
- Created: 2019-12-28T00:58:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-26T16:26:53.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:37:43.522Z (7 months ago)
- Topics: access-control, adapter, casbin, go, go-pg, golang, pg
- Language: Go
- Homepage: https://github.com/casbin/casbin
- Size: 74.2 KB
- Stars: 39
- Watchers: 4
- Forks: 28
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go-pg Adapter
[](https://github.com/casbin/casbin-pg-adapter/actions/workflows/ci.yml)
[](https://coveralls.io/github/casbin/casbin-pg-adapter?branch=master)
Go-pg Adapter is the [Go-pg](https://github.com/go-pg/pg) adapter for [Casbin](https://github.com/casbin/casbin). With this library, Casbin can load policy from PostgreSQL or save policy to it.
## Installation
go get github.com/casbin/casbin-pg-adapter
## Simple Postgres Example
```go
package main
import (
pgadapter "github.com/casbin/casbin-pg-adapter"
"github.com/casbin/casbin/v2"
)
func main() {
// Initialize a Go-pg 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, _ := pgadapter.NewAdapter("postgresql://username:password@postgres:5432/database?sslmode=disable") // Your driver and data source.
// Alternatively, you can construct an adapter instance with *pg.Options:
// a, _ := pgadapter.NewAdapter(&pg.Options{
// Database: "...",
// User: "...",
// Password: "...",
// })
// The adapter will use the table named "casbin_rule".
// If it doesn't exist, the adapter will create it automatically.
// Or you can use an existing DB by adding a second string parameter with your database name to the NewAdapter(), like this:
// a, _ := pgadapter.NewAdapter("postgresql://username:password@postgres:5432/database?sslmode=disable", "your_database_name")
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()
}
```
## Support for FilteredAdapter interface
You can [load a subset of policies](https://casbin.org/docs/policy-subset-loading) with this adapter:
```go
package main
import (
"github.com/casbin/casbin/v2"
pgadapter "github.com/casbin/casbin-pg-adapter"
)
func main() {
a, _ := pgadapter.NewAdapter("postgresql://username:password@postgres:5432/database?sslmode=disable")
e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a)
e.LoadFilteredPolicy(&pgadapter.Filter{
P: []string{"", "data1"},
G: []string{"alice"},
})
...
}
```
## Custom DB Connection
You can provide a custom table or database name with `pgadapter.NewAdapterByDB`
```go
package main
import (
"github.com/casbin/casbin/v2"
pgadapter "github.com/casbin/casbin-pg-adapter"
"github.com/go-pg/pg/v9"
)
func main() {
opts, _ := pg.ParseURL("postgresql://pguser:pgpassword@localhost:5432/pgdb?sslmode=disable")
db := pg.Connect(opts)
defer db.Close()
a, _ := pgadapter.NewAdapterByDB(db, pgadapter.WithTableName("custom_table"))
e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a)
...
}
```
## Run all tests
docker-compose run --rm go
## Debug tests
docker-compose run --rm go dlv test github.com/casbin/casbin-pg-adapter
## 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.