flask-casbin

🚨 This project has been merged into the official Flask implementation Flask-authz 🚨

A Flask Casbin interface that allows you to decorate routes

Installation / Usage

To install use pip:

TBD

Or clone the repo:

$ git clone https://github.com/sciencelogic/flask-casbin.git
$ python setup.py install

Module Usage:

app=Flask(__name__)
# Set up Casbin model configapp.config['CASBIN_MODEL'] ='casbinmodel.conf'# Set headers where owner for enforcement policy should be locatedapp.config['CASBIN_OWNER_HEADERS'] = {'X-User', 'X-Group'}
# Set up Casbin Adapteradapter=casbin_couchbase_adapter.Adapter(...)
casbin_enforcer=CasbinEnforcer(app, adapter)
@app.route('/', methods=['GET'])@casbin_enforcer.enforcerdefget_root():
returnjsonify({'message': 'If you see this you have access'})
@app.route('/manager', methods=['POST'])@casbin_enforcer.enforcer@casbin_enforcer.managerdefmake_casbin_change(manager):
# Manager is an casbin.enforcer.Enforcer object to make changes to Casbinreturnjsonify({'message': 'If you see this you have access'})

Example casbinmodel.conf

[request_definition]r = sub, obj, act
[policy_definition]p = sub, obj, act
[role_definition]g = _, _
[policy_effect]e = some(where (p.eft == allow))
[matchers]m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act

This example file can be found in tests/casbin_files along with an example RBAC policy file.

Development

1. Fork
2. Install Dev ENV

# Install Flask-Casbin with Dev packagespipinstall-rdev_requirements.txtpipinstall-rrequirements.txtpipinstall-e .
# Install Pre-commitspre-commitinstall# Create feature branchgitcheckout-bfeature-more-cool-stuff# Code stuff

Then push your changes and create a PR

Manually Bump Version

bumpversion major # major release
or
bumpversion minor # minor release
or
bumpversion patch # hotfix release