jsonadapter

README

JSON Adapter

This is the JSON Array Adapter, which is a fork of the standard JSON Adapter for Casbin. With this library, Casbin can load policy from JSON string or save policy to it.

The primary difference between this and the JSON used by the standard JSON Adapter is that this one uses an array of strings for the policy JSON:

[
  ["p","alice","data1","read"],
  ["p","bob","data2","write"],
  ["p","data2_admin","data2","read"],
  ["p","data2_admin","data2","write"],
  ["g","alice","data2_admin"]
]

Other than the format change, the two JSON adapters are identical and have an interchangeable API.

Installation

go get github.com/userifydevteam/json-array-adapter

Simple Example

package main

import (
	"github.com/casbin/casbin/v2"
    "github.com/userifydevteam/json-array-adapter/v2"
)

func main() {
	// Initialize a JSON adapter and use it in a Casbin enforcer:
	b := []byte{} // b stores Casbin policy in JSON bytes.
	a := jsonadapter.NewAdapter(&b) // Use b as the data source. 
	e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a)
	
	// Load the policy from JSON bytes b.
	e.LoadPolicy()
	
	// Check the permission.
	e.Enforce("alice", "data1", "read")
	
	// Modify the policy.
	// e.AddPolicy(...)
	// e.RemovePolicy(...)
	
	// Save the policy back to JSON bytes b.
	e.SavePolicy()
}

Policy JSON

The following illustrates the expected JSON format for a policy. The rbac_policy.json has the same policy found in rbac_policy.csv.

[
  ["p","alice","data1","read"],
  ["p","bob","data2","write"],
  ["p","data2_admin","data2","read"],
  ["p","data2_admin","data2","write"],
  ["g","alice","data2_admin"]
]

Getting Help

• Casbin

License

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

Documentation

Index

• type Adapter
  • func NewAdapter(source *[]byte) *Adapter
  • func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error
  • func (a *Adapter) LoadPolicy(model model.Model) error
  • func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error
  • func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error
  • func (a *Adapter) SavePolicy(model model.Model) error
• type CasbinRule

Types

type Adapter

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

Adapter represents the Redis adapter for policy storage. It can load policy from JSON bytes or save policy to JSON bytes.

func NewAdapter

func NewAdapter(source *[]byte) *Adapter

NewAdapter is the constructor for Adapter.

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) 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 []string