# flask-authz
[](https://github.com/officialpycasbin/flask-authz/actions)
[](https://coveralls.io/github/officialpycasbin/flask-authz)
[](https://pypi.org/project/flask-authz/)
[](https://pypi.org/project/flask-authz/)
[](https://pypi.org/project/flask-authz/)
[](https://pypi.org/project/flask-authz/)
[](https://discord.gg/S5UjpzGZjN)
flask-authz is an authorization middleware for [Flask](http://flask.pocoo.org/), it's based on [PyCasbin](https://github.com/casbin/pycasbin).
## Installation
```
pip install flask-authz
```
Or clone the repo:
```
$ git clone https://github.com/officialpycasbin/flask-authz.git
$ python setup.py install
```
Module Usage:
```python
from flask import Flask
from flask_authz import CasbinEnforcer
from casbin.persist.adapters import FileAdapter
app = Flask(__name__)
# Set up Casbin model config
app.config['CASBIN_MODEL'] = 'casbinmodel.conf'
# Set headers where owner for enforcement policy should be located
app.config['CASBIN_OWNER_HEADERS'] = {'X-User', 'X-Group'}
# Add User Audit Logging with user name associated to log
# i.e. `[2020-11-10 12:55:06,060] ERROR in casbin_enforcer: Unauthorized attempt: method: GET resource: /api/v1/item by user: janedoe@example.com`
app.config['CASBIN_USER_NAME_HEADERS'] = {'X-User'}
# Set up Casbin Adapter
adapter = FileAdapter('rbac_policy.csv')
casbin_enforcer = CasbinEnforcer(app, adapter)
@app.route('/', methods=['GET'])
@casbin_enforcer.enforcer
def get_root():
return jsonify({'message': 'If you see this you have access'})
@app.route('/manager', methods=['POST'])
@casbin_enforcer.enforcer
@casbin_enforcer.manager
def make_casbin_change(manager):
# Manager is an casbin.enforcer.Enforcer object to make changes to Casbin
return jsonify({'message': 'If you see this you have access'})
```
Example Config
This example file can be found in `tests/casbin_files`
```ini
[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 = (p.sub == "*" || g(r.sub, p.sub)) && r.obj == p.obj && (p.act == "*" || r.act == p.act)
```
Example Policy
This example file can be found in `tests/casbin_files`
```csv
p, alice, /dataset1/*, GET
p, alice, /dataset1/resource1, POST
p, bob, /dataset2/resource1, *
p, bob, /dataset2/resource2, GET
p, bob, /dataset2/folder1/*, POST
p, dataset1_admin, /dataset1/*, *
p, *, /login, *
p, anonymous, /, GET
g, cathy, dataset1_admin
```
Development
------------
#### Run unit tests
1. Fork/Clone repository
2. Install flask-authz dependencies, and run `pytest`
```python
pip install -r dev_requirements.txt
pip install -r requirements.txt
pytest
```
#### Setup pre-commit checks
```python
pre-commit install
```
#### update requirements with pip-tools
```bash
# update requirements.txt
pip-compile --no-annotate --no-header --rebuild requirements.in
# sync venv
pip-sync
```
#### Manually Bump Version
```
bumpversion major # major release
or
bumpversion minor # minor release
or
bumpversion patch # hotfix release
```
## Documentation
The authorization determines a request based on ``{subject, object, action}``, which means what ``subject`` can perform what ``action`` on what ``object``. In this plugin, the meanings are:
1. ``subject``: the logged-in user name
2. ``object``: the URL path for the web resource like "dataset1/item1"
3. ``action``: HTTP method like GET, POST, PUT, DELETE, or the high-level actions you defined like "read-file", "write-blog"
For how to write authorization policy and other details, please refer to [the Casbin's documentation](https://casbin.org).
## Getting Help
- [Casbin](https://casbin.org)
## License
This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.
Raw data
{
"_id": null,
"home_page": "https://github.com/officialpycasbin/flask-authz",
"name": "flask-authz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "flask, pycasbin, casbin, auth, authz, acl, rbac, abac, access control, authorization, permission",
"author": "['Yang Luo', 'Sciencelogic']",
"author_email": "hsluoyz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/93/360f02820352c310e7a0d5625f05718b88eb23e17110a24b0fbec3000ba8/flask_authz-2.7.0.tar.gz",
"platform": null,
"description": "# flask-authz\n\n[](https://github.com/officialpycasbin/flask-authz/actions)\n[](https://coveralls.io/github/officialpycasbin/flask-authz)\n[](https://pypi.org/project/flask-authz/)\n[](https://pypi.org/project/flask-authz/)\n[](https://pypi.org/project/flask-authz/)\n[](https://pypi.org/project/flask-authz/)\n[](https://discord.gg/S5UjpzGZjN)\n\nflask-authz is an authorization middleware for [Flask](http://flask.pocoo.org/), it's based on [PyCasbin](https://github.com/casbin/pycasbin).\n\n## Installation\n\n```\npip install flask-authz\n```\nOr clone the repo:\n```\n$ git clone https://github.com/officialpycasbin/flask-authz.git\n$ python setup.py install\n```\n\nModule Usage:\n```python\nfrom flask import Flask\nfrom flask_authz import CasbinEnforcer\nfrom casbin.persist.adapters import FileAdapter\n\napp = Flask(__name__)\n# Set up Casbin model config\napp.config['CASBIN_MODEL'] = 'casbinmodel.conf'\n# Set headers where owner for enforcement policy should be located\napp.config['CASBIN_OWNER_HEADERS'] = {'X-User', 'X-Group'}\n# Add User Audit Logging with user name associated to log\n# i.e. `[2020-11-10 12:55:06,060] ERROR in casbin_enforcer: Unauthorized attempt: method: GET resource: /api/v1/item by user: janedoe@example.com`\napp.config['CASBIN_USER_NAME_HEADERS'] = {'X-User'}\n# Set up Casbin Adapter\nadapter = FileAdapter('rbac_policy.csv')\ncasbin_enforcer = CasbinEnforcer(app, adapter)\n\n@app.route('/', methods=['GET'])\n@casbin_enforcer.enforcer\ndef get_root():\n return jsonify({'message': 'If you see this you have access'})\n\n@app.route('/manager', methods=['POST'])\n@casbin_enforcer.enforcer\n@casbin_enforcer.manager\ndef make_casbin_change(manager):\n # Manager is an casbin.enforcer.Enforcer object to make changes to Casbin\n return jsonify({'message': 'If you see this you have access'})\n```\nExample Config\nThis example file can be found in `tests/casbin_files`\n```ini\n[request_definition]\nr = sub, obj, act\n\n[policy_definition]\np = sub, obj, act\n\n[role_definition]\ng = _, _\n\n[policy_effect]\ne = some(where (p.eft == allow))\n\n[matchers]\nm = (p.sub == \"*\" || g(r.sub, p.sub)) && r.obj == p.obj && (p.act == \"*\" || r.act == p.act)\n```\nExample Policy\nThis example file can be found in `tests/casbin_files`\n```csv\np, alice, /dataset1/*, GET\np, alice, /dataset1/resource1, POST\np, bob, /dataset2/resource1, *\np, bob, /dataset2/resource2, GET\np, bob, /dataset2/folder1/*, POST\np, dataset1_admin, /dataset1/*, *\np, *, /login, *\n\np, anonymous, /, GET\n\ng, cathy, dataset1_admin\n```\n\nDevelopment\n------------\n\n#### Run unit tests\n1. Fork/Clone repository\n2. Install flask-authz dependencies, and run `pytest`\n```python\npip install -r dev_requirements.txt\npip install -r requirements.txt\npytest\n```\n\n#### Setup pre-commit checks\n```python\npre-commit install\n```\n\n\n#### update requirements with pip-tools\n```bash\n# update requirements.txt\npip-compile --no-annotate --no-header --rebuild requirements.in\n# sync venv\npip-sync\n```\n\n#### Manually Bump Version\n```\nbumpversion major # major release\nor\nbumpversion minor # minor release\nor\nbumpversion patch # hotfix release\n```\n\n## Documentation\n\nThe authorization determines a request based on ``{subject, object, action}``, which means what ``subject`` can perform what ``action`` on what ``object``. In this plugin, the meanings are:\n\n1. ``subject``: the logged-in user name\n2. ``object``: the URL path for the web resource like \"dataset1/item1\"\n3. ``action``: HTTP method like GET, POST, PUT, DELETE, or the high-level actions you defined like \"read-file\", \"write-blog\"\n\nFor how to write authorization policy and other details, please refer to [the Casbin's documentation](https://casbin.org).\n\n## Getting Help\n\n- [Casbin](https://casbin.org)\n\n## License\n\nThis project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "An authorization middleware for Flask that supports ACL, RBAC, ABAC, based on Casbin",
"version": "2.7.0",
"project_urls": {
"Download": "https://github.com/officialpycasbin/flask-authz/tarball/v2.7.0",
"Homepage": "https://github.com/officialpycasbin/flask-authz"
},
"split_keywords": [
"flask",
" pycasbin",
" casbin",
" auth",
" authz",
" acl",
" rbac",
" abac",
" access control",
" authorization",
" permission"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "433c70a1cbb127ef8e46648bd031994f6a2ca97c0004d66e6cf706f1e1bd428e",
"md5": "02619eb45e7797b59266b8247f8b24a2",
"sha256": "15f03114e10050a19712d57494016b655215d1e5f902f85fb73bd55ea910677b"
},
"downloads": -1,
"filename": "flask_authz-2.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "02619eb45e7797b59266b8247f8b24a2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 12925,
"upload_time": "2024-11-12T02:54:06",
"upload_time_iso_8601": "2024-11-12T02:54:06.781526Z",
"url": "https://files.pythonhosted.org/packages/43/3c/70a1cbb127ef8e46648bd031994f6a2ca97c0004d66e6cf706f1e1bd428e/flask_authz-2.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b93360f02820352c310e7a0d5625f05718b88eb23e17110a24b0fbec3000ba8",
"md5": "9acf5e40b145e25c23c4ff48746ab6d1",
"sha256": "0bce065314678d15075b9da6b71f466913ce470d76d365960168c50213bd1ee2"
},
"downloads": -1,
"filename": "flask_authz-2.7.0.tar.gz",
"has_sig": false,
"md5_digest": "9acf5e40b145e25c23c4ff48746ab6d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 13732,
"upload_time": "2024-11-12T02:54:08",
"upload_time_iso_8601": "2024-11-12T02:54:08.337256Z",
"url": "https://files.pythonhosted.org/packages/4b/93/360f02820352c310e7a0d5625f05718b88eb23e17110a24b0fbec3000ba8/flask_authz-2.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 02:54:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "officialpycasbin",
"github_project": "flask-authz",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "flask-authz"
}
JSON
