casbin-redis-adapter

KO | EN

gitlite — search

#javascript #python #react #llm #android #machine-learning #deep-learning #linux #macos #java #awesome #cli #awesome-list #pytorch

casbin-redis-adapter

(★ 200)

Redis adapter for Casbin

File Explorer

Download Latest Version (.zip)

- - ci.yml
- rbac_model.conf
- rbac_policy.csv
.gitignore
.releaserc.json
adapter.go
adapter_config_test.go
adapter_test.go
go.mod
go.sum
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Redis Adapter
====

[![Go Report Card](https://goreportcard.com/badge/github.com/casbin/redis-adapter)](https://goreportcard.com/report/github.com/casbin/redis-adapter)
[![Build](https://github.com/casbin/redis-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/casbin/redis-adapter/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/casbin/redis-adapter/badge.svg?branch=master)](https://coveralls.io/github/casbin/redis-adapter?branch=master)
[![Godoc](https://godoc.org/github.com/casbin/redis-adapter?status.svg)](https://pkg.go.dev/github.com/casbin/redis-adapter/v3)
[![Release](https://img.shields.io/github/release/casbin/redis-adapter.svg)](https://github.com/casbin/redis-adapter/releases/latest)
[![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2)](https://discord.gg/S5UjpzGZjN)
[![Sourcegraph](https://sourcegraph.com/github.com/casbin/redis-adapter/-/badge.svg)](https://sourcegraph.com/github.com/casbin/redis-adapter?badge)

Redis Adapter is the [Redis](https://redis.io/) adapter for [Casbin](https://github.com/casbin/casbin). With this library, Casbin can load policy from Redis or save policy to it.

## Installation

go get github.com/casbin/redis-adapter/v3

## Configuration Options

The `Config` struct supports the following options:

- `Network` (string): Network type, e.g., "tcp", "unix" (required when not using Pool)
- `Address` (string): Redis server address, e.g., "127.0.0.1:6379" (required when not using Pool)
- `Key` (string): Redis key to store Casbin rules (default: "casbin_rules")
- `Username` (string): Username for Redis authentication (optional)
- `Password` (string): Password for Redis authentication (optional)
- `TLSConfig` (*tls.Config): TLS configuration for secure connections (optional)
- `Pool` (*redis.Pool): Existing Redis connection pool (optional, if provided, other connection options are ignored)

## Usage Examples

### Basic Usage

```go
package main

import (
	"github.com/casbin/casbin/v2"
	"github.com/casbin/redis-adapter/v3"
)

func main() {
	// Recommended approach using Config
	config := &redisadapter.Config{Network: "tcp", Address: "127.0.0.1:6379"}
	a, _ := redisadapter.NewAdapter(config)

// With password authentication
	// config := &redisadapter.Config{Network: "tcp", Address: "127.0.0.1:6379", Password: "123"}
	// a, _ := redisadapter.NewAdapter(config)

// With user credentials
	// config := &redisadapter.Config{Network: "tcp", Address: "127.0.0.1:6379", Username: "user", Password: "pass"}
	// a, _ := redisadapter.NewAdapter(config)

// With TLS configuration
	// var clientTLSConfig tls.Config
	// ...
	// config := &redisadapter.Config{Network: "tcp", Address: "127.0.0.1:6379", Username: "testAccount", Password: "123456", TLSConfig: &clientTLSConfig}
	// a, _ := redisadapter.NewAdapter(config)

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()
}
```

### With Connection Pool

```go
package main

import (
	"github.com/casbin/casbin/v2"
	"github.com/casbin/redis-adapter/v3"
	"github.com/gomodule/redigo/redis"
)

func main() {
	pool := &redis.Pool{Dial: func() (redis.Conn, error) { return redis.Dial("tcp", "127.0.0.1:6379") }}
	config := &redisadapter.Config{Pool: pool, Key: "casbin_rules"}
	a, _ := redisadapter.NewAdapter(config)

e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a)
	
	// Load the policy from DB.
	e.LoadPolicy()

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

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

## 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-redis-adapter

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

casbin-redis-adapter

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README