https://github.com/juicycleff/casbin-mongodb-adapter

Pure MongoDB adapter for Casbin
https://github.com/juicycleff/casbin-mongodb-adapter

casbin casbin-adapter mongodb mongojs node-mongodb

Last synced: 19 days ago
JSON representation

Pure MongoDB adapter for Casbin

• Host: GitHub
• URL: https://github.com/juicycleff/casbin-mongodb-adapter
• Owner: juicycleff
• License: mit
• Created: 2019-10-23T14:10:31.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-29T18:20:51.000Z (about 2 years ago)
• Last Synced: 2024-04-14T09:58:57.128Z (7 months ago)
• Topics: casbin, casbin-adapter, mongodb, mongojs, node-mongodb
• Language: TypeScript
• Size: 301 KB
• Stars: 8
• Watchers: 4
• Forks: 13
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
casbin-mongodb-adapter

===

MongoDB policy storage, implemented as an adapter for [node-casbin](https://github.com/casbin/node-casbin).



  





  





  





  





  





  





  



## Getting Started

Install the package as dependency in your project:

```bash

npm install --save casbin-mongodb-adapter

```

Require it in a place, where you are instantiating an enforcer ([read more about enforcer here](https://github.com/casbin/node-casbin#get-started)):

```javascript

import {newEnforcer, Enforcer} from 'casbin';

import { MongoAdapter } from 'casbin-mongodb-adapter';

import * as path from 'path';

async function myFunction() {

  const model = path.resolve(__dirname, 'casbin-files/rbac_model.conf');

  const adapter = await MongoAdapter.newAdapter({

    uri: 'mongodb://localhost:27017',

    collection: 'casbin',

    database: 'node-casbin-official'

  });

  const e = await newEnforcer(model, adapter);

  await e.loadPolicy();

  // Check the permission.

  e.enforce('alice', 'data1', 'read');

  // Modify the policy.

  // await e.addPolicy(...);

  // await e.removePolicy(...);

  // Save the policy back to DB.

  await e.savePolicy();

}

```

That is all what required for integrating the adapter into casbin.

Casbin itself calls adapter methods to persist updates you made through it.

## Configuration

You can pass mongodb-specific options when instantiating the adapter:

```javascript

import { MongoAdapter } from 'casbin-mongodb-adapter';

const adapter = await MongoAdapter.newAdapter({

  uri: 'mongodb://localhost:27017',

  collection: 'casbin',

  database: 'node-casbin-official',

  option: {

    ...mongoOptions

  }

});

```

Additional information regard to options you can pass in you can find in [mongodb documentation](https://mongodb.github.io/node-mongodb-native/)

## License

[Apache-2.0](./LICENSE)