mongodbadapter

README

MongoDB Adapter

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

Installation

go get -u github.com/anymetrica/casbin-mongo-adapter

Simple Example

package main

import (
	"github.com/casbin/casbin/v2"
	"github.com/anymetrica/casbin-mongo-adapter"
)

func main() {
	// Initialize a MongoDB adapter and use it in a Casbin enforcer:
	// The adapter will use the database named "casbin".
	// If it doesn't exist, the adapter will create it automatically.
	a,err := mongodbadapter.NewAdapter("127.0.0.1:27017") // Your MongoDB URL. 
	if err != nil {
		panic(err)
	}
	// 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 := mongodbadapter.NewAdapter("127.0.0.1:27017/abc")

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

Advanced Example

package main

import (
	"github.com/casbin/casbin/v2"
	"github.com/casbin/mongodb-adapter/v3"
	mongooptions "go.mongodb.org/mongo-driver/mongo/options"
)

func main() {
	// Initialize a MongoDB adapter with NewAdapterWithClientOption:
	// The adapter will use custom mongo client options.
	// custom database name.
	// default collection name 'casbin_rule'.
	mongoClientOption := mongooptions.Client().ApplyURI("mongodb://127.0.0.1:27017")
	databaseName := "casbin"
	a,err := mongodbadapter.NewAdapterWithClientOption(mongoClientOption, databaseName)
	// Or you can use NewAdapterWithCollectionName for custom collection name.
	if err != nil {
		panic(err)
	}

	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 "github.com/globalsign/mgo/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

• Casbin

License

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

Documentation

Index

• func NewAdapter(url string, timeout ...interface{}) (persist.BatchAdapter, error)
• func NewAdapterByDB(client *mongo.Client, config *AdapterConfig) (persist.ContextFilteredAdapter, error)
• func NewAdapterWithClientOption(clientOption *options.ClientOptions, databaseName string, ...) (persist.BatchAdapter, error)
• func NewAdapterWithCollectionName(clientOption *options.ClientOptions, databaseName string, ...) (persist.BatchAdapter, error)
• func NewFilteredAdapter(url string) (persist.FilteredAdapter, error)
• type AdapterConfig
• type CasbinRule

Functions

func NewAdapter

func NewAdapter(url string, timeout ...interface{}) (persist.BatchAdapter, error)

NewAdapter is the constructor for Adapter. If database name is not provided in the Mongo URL, 'casbin' will be used as database name. 'casbin_rule' will be used as a collection name.

func NewAdapterByDB

func NewAdapterByDB(client *mongo.Client, config *AdapterConfig) (persist.ContextFilteredAdapter, error)

func NewAdapterWithClientOption

func NewAdapterWithClientOption(clientOption *options.ClientOptions, databaseName string, timeout ...interface{}) (persist.BatchAdapter, error)

NewAdapterWithClientOption is an alternative constructor for Adapter that does the same as NewAdapter, but uses mongo.ClientOption instead of a Mongo URL + a databaseName option

func NewAdapterWithCollectionName

func NewAdapterWithCollectionName(clientOption *options.ClientOptions, databaseName string, collectionName string, timeout ...interface{}) (persist.BatchAdapter, error)

NewAdapterWithCollectionName is an alternative constructor for Adapter that does the same as NewAdapterWithClientOption, but with an extra collectionName option

func NewFilteredAdapter

func NewFilteredAdapter(url string) (persist.FilteredAdapter, error)

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

Types

type AdapterConfig

type AdapterConfig struct {
	DatabaseName   string
	CollectionName string
	Timeout        time.Duration
	IsFiltered     bool
}

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.