redisadapter

package module
v2.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 8, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

README

Redis Adapter Godoc

Redis Adapter for go-redis is the Redis adapter for Casbin, but with [go-redis] (https://github.com/go-redis/redis) as its client library. With this library, Casbin can load policy from Redis or save policy to it.

Installation

go get github.com/mintxtinm/go-redis-adapter/v2

Simple Example

package main

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

func main() {
	// Initialize a Redis adapter and use it in a Casbin enforcer:
	a := redisadapter.NewAdapter("tcp", "127.0.0.1:6379") // Your Redis network and address.
	// Use the following if Redis has password like "123"
    //a := redisadapter.NewAdapterWithPassword("tcp", "127.0.0.1:6379", "123")
	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()
}

Getting Help

License

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Adapter

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

Adapter represents the Redis adapter for policy storage.

func NewAdapter

func NewAdapter(network string, address string) *Adapter

NewAdapter is the constructor for Adapter.

func NewAdapterWithKey

func NewAdapterWithKey(network string, address string, key string) *Adapter

NewAdapterWithKey is the constructor for Adapter.

func NewAdapterWithPassword

func NewAdapterWithPassword(network string, address string, password string) *Adapter

NewAdapterWithPassword is the constructor for Adapter.

func NewAdpaterWithOption

func NewAdpaterWithOption(options ...Option) *Adapter

func (*Adapter) AddPolicies

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

AddPolicies adds 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) 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 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 {
	PType string `xorm:"varchar(100) index"`
	V0    string `xorm:"varchar(100) index"`
	V1    string `xorm:"varchar(100) index"`
	V2    string `xorm:"varchar(100) index"`
	V3    string `xorm:"varchar(100) index"`
	V4    string `xorm:"varchar(100) index"`
	V5    string `xorm:"varchar(100) index"`
}

CasbinRule is used to determine which policy line to load.

type Option

type Option func(*Adapter)

func WithAddress

func WithAddress(address string) Option

func WithKey

func WithKey(key string) Option

func WithNetwork

func WithNetwork(network string) Option

func WithPassword

func WithPassword(password string) Option

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL