mongodbadapter

README

MongoDB Adapter

This fork uses the official MongoDB Go Driver instead of MGO, based on github.com/ditchx/mongodb-adapter, but adding database name discovery.

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 github.com/ylamothe/mongodb-adapter

Simple Example

package main

import (
	"github.com/casbin/casbin"
	"github.com/ditchx/mongodb-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 := mongodbadapter.NewAdapter("mongodb://127.0.0.1:27017") // Your MongoDB URL.

	// 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", mongodbadapter.DBName("abc") )

	// You can also pass a connected *mongo.Client if you want to reuse one.
	// The adapter will not be responsible for automatically connecting/disconnecting the client, though.
	// client, _ := mongo.Connect(context.Background(), options.Client().ApplyURI("mongodb://127.0.0.1:27017"))
	// a := mongodbadapter.NewAdapterFromClient(client, mongodbadapter.DBName("abc") )

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

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

• func DBName(databaseName string) func(*adapter)
• func Filtered(filtered bool) func(*adapter)
• func NewAdapter(url string, opts ...func(*adapter)) persist.Adapter
• func NewAdapterFromClient(cl *mongo.Client, opts ...func(*adapter)) persist.Adapter
• func NewFilteredAdapter(url string, opts ...func(*adapter)) persist.FilteredAdapter
• type CasbinRule

Functions

func DBName

func DBName(databaseName string) func(*adapter)

DBName sets the name of the database to be used by casbin

func Filtered

func Filtered(filtered bool) func(*adapter)

Filtered sets flags for filtered policy

func NewAdapter

func NewAdapter(url string, opts ...func(*adapter)) persist.Adapter

NewAdapter is the constructor for Adapter.

func NewAdapterFromClient

func NewAdapterFromClient(cl *mongo.Client, opts ...func(*adapter)) persist.Adapter

NewAdapterFromClient creates a new adapter from an existing connected mongodb client. Intended for reusing an already established client connection. Opening and Closing client connection will not be handled by the adapter.

func NewFilteredAdapter

func NewFilteredAdapter(url string, opts ...func(*adapter)) persist.FilteredAdapter

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.