qmgoadapter

package module
v0.0.0-...-ce1e004 Latest Latest
Warning

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

Go to latest
Published: Dec 10, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

README

Casbin Qmgo Adapter

Casbin Qmgo Adapter is the Qmgo adapter for Casbin. With this library, Casbin can load policy from MongoDB or save policy to it.

Installation

go get -u github.com/beiyanpiki/casbin-qmgo-adapter

Simple Example

package main

import (
	"context"

	qmgoadapter "github.com/beiyanpiki/casbin-qmgo-adapter"
	"github.com/casbin/casbin/v2"
	"github.com/qiniu/qmgo"
)

func main() {
	// Initialize Qmgo.Client, Qmgo.Database and Qmgo.Collection.
	c, err := qmgo.NewClient(context.Background(), &qmgo.Config{Uri: "mongodb://127.0.0.1:27017"})
	if err != nil {
		panic(err)
	}
	coll := c.Database("Casbin").Collection("Casbin")
	// Initialize a Qmgo adapter and use it in a Casbin enforcer.
	a := qmgoadapter.NewAdapter(coll)

	e, err := casbin.NewEnforcer("examples/rbac_model.conf", a)
	if err != nil {
		panic(err)
	}

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

Filtered Policies

import "go.mongodb.org/mongo-driver/bson"

// This adapter also implements the FilteredAdapter interface. This allows for
// efficent, scalable enforcement of very large policies:
filter := &bson.M{"v0": "alice"}
e.LoadFilteredPolicy(filter)

// The loaded policy is now a subset of the policy in storage, containing only
// the policy lines that match the provided filter. This filter should be a
// valid MongoDB selector using BSON. A filtered policy cannot be saved.

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

func NewAdapter

func NewAdapter(coll *qmgo.Collection) persist.Adapter

NewAdapter is the constructor for Adapter. You need to provide a qmgo.Collection which is already defined.

Example:

client, _ := qmgo.NewClient(context.Background(), &qmgo.Config{
	Uri:              	"mongodb://127.0.0.1:27017/?authSource=admin&replicaSet=rs0",
	ConnectTimeoutMS:=	time.Second * 30,
	MaxPoolSize:      	100,
	Auth: 				qmgo.Credential{
		AuthSource: "admin",
		Username:   "root",
		Password:   "rootroot",
	},
})

coll := c.Database("Dbname").Collection("CasbinName") a, err := casbinqmgoadapter.NewAdapter(coll)

func NewFilteredAdapter

func NewFilteredAdapter(coll *qmgo.Collection) (persist.FilteredAdapter, error)

NewFilteredAdapter is the constructor for FilteredAdapter. Casbin will not automatically call LoadPolicy() for a filtered adapter.

Types

type CasbinRule

type CasbinRule struct {
	PType string
	V0    string
	V1    string
	V2    string
	V3    string
	V4    string
	V5    string
}

CasbinRule represents a rule in Casbin.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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