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.

Note: This library use the official go-mongo-driver.

Installation

go get -u github.com/litixsoft/mongodb-adapter

Simple Example

package main

import (
	"github.com/casbin/casbin/v2"
	"github.com/litixsoft/mongodb-adapter"
)

func main() {
	// Initialize a MongoDB adapter and use it in a Casbin enforcer:
	// The adapter accept a mongodb uri string, a *mongo.Database or *mongo.Collection 
    // If no database given in uri string, the adapter will use the database named "casbin".
	a := mongodbadapter.NewAdapter("mongodb://127.0.0.1:27017") // Your MongoDB URI. 
	
	// 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("mongodb://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()
}

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

• Casbin

License

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

Documentation

Index

• Constants
• func NewAdapter(param interface{}) (persist.Adapter, error)
• func NewAdapterWithCollection(mCollection *mongo.Collection) (persist.Adapter, error)
• func NewAdapterWithDatabase(mDatabase *mongo.Database) (persist.Adapter, error)
• func NewFilteredAdapter(uri string) (persist.FilteredAdapter, error)
• type CasbinRule

Constants

const CasbinMongodbCollectionname = "casbin_rule"

const CasbinMongodbDatabasename = "casbin"

const ContextTimeout = 30 * time.Second

Functions

func NewAdapter

func NewAdapter(param interface{}) (persist.Adapter, error)

NewAdapter is the constructor for Adapter. param can be a mongodb uri string, *mongo.Database or *mongo.Collection If database name is not provided in the Mongo URI, 'casbin' will be used as database name.

func NewAdapterWithCollection

func NewAdapterWithCollection(mCollection *mongo.Collection) (persist.Adapter, error)

NewAdapterWithDatabase is an alternative constructor for Adapter that does the same as NewAdapter, but uses *mongo.Collection instead of a Mongo URI

func NewAdapterWithDatabase

func NewAdapterWithDatabase(mDatabase *mongo.Database) (persist.Adapter, error)

NewAdapterWithDatabase is an alternative constructor for Adapter that does the same as NewAdapter, but uses *mongo.Database instead of a Mongo URI

func NewFilteredAdapter

func NewFilteredAdapter(uri string) (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.