├── .eslintrc.json ├── .gitignore ├── .travis.yml ├── BasicAuthorizer.js ├── LICENSE ├── README.md ├── authz.js ├── examples ├── authz_model.conf └── authz_policy.csv ├── package.json ├── test ├── customize.test.js ├── customizeServer.js ├── server.js └── test.js └── yarn.lock /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "standard" 3 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | .idea/ 64 | *.iml -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | 3 | sudo: false 4 | 5 | node_js: 6 | - 'stable' 7 | - '8' 8 | 9 | script: echo "Running tests against $(node -v)..." 10 | 11 | jobs: 12 | include: 13 | - stage: Produce Coverage 14 | node_js: node 15 | script: jest --coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage -------------------------------------------------------------------------------- /BasicAuthorizer.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018 The Casbin Authors. All Rights Reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | // BasicAuthorizer class stores the casbin handler 16 | class BasicAuthorizer { 17 | constructor (ctx, enforcer) { 18 | this.ctx = ctx 19 | this.enforcer = enforcer 20 | } 21 | 22 | // getUserName gets the user name from the request. 23 | // Currently, only HTTP basic authentication is supported 24 | getUserName () { 25 | // customize to get username from context 26 | const {user} = this.ctx 27 | const {username} = user 28 | return username 29 | } 30 | 31 | // checkPermission checks the user/method/path combination from the request. 32 | // Returns true (permission granted) or false (permission forbidden) 33 | async checkPermission () { 34 | const {ctx, enforcer} = this 35 | const {originalUrl: path, method} = ctx 36 | const user = this.getUserName() 37 | return await enforcer.enforce(user, path, method) 38 | } 39 | } 40 | 41 | module.exports = BasicAuthorizer 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Koa-Authz 2 | ==== 3 | [![NPM version][npm-image]][npm-url] 4 | [![NPM download][download-image]][download-url] 5 | [![codebeat badge](https://codebeat.co/badges/9defa882-898c-4dcb-91a6-7e8f061ccaac)](https://codebeat.co/projects/github-com-node-casbin-koa-authz-master) 6 | [![Build Status](https://travis-ci.org/node-casbin/koa-authz.svg?branch=master)](https://travis-ci.org/node-casbin/koa-authz) 7 | [![Coverage Status](https://coveralls.io/repos/github/node-casbin/koa-authz/badge.svg?branch=master)](https://coveralls.io/github/node-casbin/koa-authz?branch=master) 8 | [![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2)](https://discord.gg/S5UjpzGZjN) 9 | 10 | [npm-image]: https://img.shields.io/npm/v/koa-authz.svg?style=flat-square 11 | [npm-url]: https://npmjs.org/package/koa-authz 12 | [download-image]: https://img.shields.io/npm/dm/koa-authz.svg?style=flat-square 13 | [download-url]: https://npmjs.org/package/koa-authz 14 | 15 | Koa-Authz is an authorization middleware for [Koa](https://github.com/koajs/koa), it's based on ``Node-Casbin``: [https://github.com/casbin/node-casbin](https://github.com/casbin/node-casbin). 16 | 17 | ## Installation 18 | ### use casbin v2.x 19 | ```shell 20 | npm install casbin@2 koa-authz@2 --save 21 | ``` 22 | 23 | ### use casbin v3.x 24 | ```shell 25 | npm install casbin@3 koa-authz@3 --save 26 | ``` 27 | 28 | ## Simple Example 29 | 30 | ```js 31 | const casbin = require('casbin') 32 | const Koa = require('koa') 33 | const app = new Koa() 34 | const authz = require('koa-authz') 35 | 36 | // response 37 | app.use(async (ctx, next) => { 38 | const start = new Date() 39 | await next() 40 | console.log(new Date() - start) 41 | }) 42 | 43 | // use authz middleware 44 | app.use(authz({ 45 | newEnforcer: async() => { 46 | // load the casbin model and policy from files, database is also supported. 47 | const enforcer = await casbin.newEnforcer('authz_model.conf', 'authz_policy.csv') 48 | return enforcer 49 | } 50 | })) 51 | 52 | // reload routes 53 | const router = require('koa-router')({prefix: '/user'}) 54 | router.get('/', (ctx) => { 55 | ctx.body = {name: 'Chalin', age: 26} 56 | }) 57 | router.put('/', (ctx) => { 58 | ctx.body = {status: 'success'} 59 | }) 60 | app.use(router.routes(), router.allowedMethods()) 61 | 62 | app.listen(3000) 63 | ``` 64 | 65 | ## Use a customized authorizer 66 | 67 | This package provides ``BasicAuthorizer``, it uses ``HTTP Basic Authentication`` as the authentication method. 68 | If you want to use another authentication method like OAuth, you needs to extends ``BasicAuthorizer`` as below: 69 | 70 | ```js 71 | class MyAuthorizer extends BasicAuthorizer { 72 | // override function 73 | getUserName () { 74 | const { username } = this.ctx.state.user 75 | return username 76 | } 77 | } 78 | 79 | app.use(authz({ 80 | newEnforcer: async () => { 81 | // load the casbin model and policy from files, database is also supported. 82 | const enforcer = await casbin.newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv') 83 | return enforcer 84 | }, 85 | authorizer: (ctx, option) => new MyAuthorizer(ctx, option) 86 | })) 87 | ``` 88 | 89 | ## How to control the access 90 | 91 | 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: 92 | 93 | 1. ``subject``: the logged-on user name 94 | 2. ``object``: the URL path for the web resource like "dataset1/item1" 95 | 3. ``action``: HTTP method like GET, POST, PUT, DELETE, or the high-level actions you defined like "read-file", "write-blog" 96 | 97 | 98 | For how to write authorization policy and other details, please refer to [the Casbin's documentation](https://casbin.org). 99 | 100 | ## Getting Help 101 | 102 | - [Node-Casbin](https://github.com/casbin/node-casbin) 103 | 104 | ## License 105 | 106 | This project is licensed under the [Apache 2.0 license](LICENSE). 107 | -------------------------------------------------------------------------------- /authz.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018 The Casbin Authors. All Rights Reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | const { Enforcer } = require('casbin') 16 | const BasicAuthorizer = require('./BasicAuthorizer') 17 | 18 | // authz returns the authorizer, uses a Casbin enforcer as input 19 | module.exports = function authz (options) { 20 | return async (ctx, next) => { 21 | try { 22 | const {newEnforcer, authorizer} = options 23 | const enforcer = await newEnforcer() 24 | if (!(enforcer instanceof Enforcer)) { 25 | throw new Error('Invalid enforcer') 26 | } 27 | const authzorizer = authorizer ? authorizer(ctx, enforcer) : new BasicAuthorizer(ctx, enforcer) 28 | if (!(authzorizer instanceof BasicAuthorizer)) { 29 | throw new Error('Please extends BasicAuthorizer class') 30 | } 31 | if (!await authzorizer.checkPermission()) { 32 | ctx.status = 403 33 | return 34 | } 35 | await next() 36 | } catch (e) { 37 | throw e 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /examples/authz_model.conf: -------------------------------------------------------------------------------- 1 | [request_definition] 2 | r = sub, obj, act 3 | 4 | [policy_definition] 5 | p = sub, obj, act 6 | 7 | [role_definition] 8 | g = _, _ 9 | 10 | [policy_effect] 11 | e = some(where (p.eft == allow)) 12 | 13 | [matchers] 14 | m = g(r.sub, p.sub) && keyMatch(r.obj, p.obj) && (r.act == p.act || p.act == "*") 15 | -------------------------------------------------------------------------------- /examples/authz_policy.csv: -------------------------------------------------------------------------------- 1 | p, alice, /dataset1/*, GET 2 | p, alice, /dataset1/resource1, POST 3 | p, bob, /dataset2/resource1, * 4 | p, bob, /dataset2/resource2, GET 5 | p, bob, /dataset2/folder1/*, POST 6 | p, dataset1_admin, /dataset1/*, * 7 | g, cathy, dataset1_admin 8 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "koa-authz", 3 | "version": "3.0.1", 4 | "description": "koa-authz is an authorization middleware for Koa", 5 | "main": "authz.js", 6 | "scripts": { 7 | "prepublish": "npm run lint && npm run test", 8 | "fix": "eslint \"authz.js\" --fix", 9 | "lint": "eslint \"authz.js\"", 10 | "test": "jest" 11 | }, 12 | "keywords": [ 13 | "node-casbin", 14 | "koajs", 15 | "koa2", 16 | "authz", 17 | "authorization", 18 | "middleware" 19 | ], 20 | "repository": { 21 | "type": "git", 22 | "url": "https://github.com/node-casbin/koa-authz.git" 23 | }, 24 | "author": { 25 | "name": "Chalin-Shi", 26 | "email": "18875906195@163.com" 27 | }, 28 | "engines": { 29 | "node": ">= 7.6.0" 30 | }, 31 | "license": "http://www.apache.org/licenses/LICENSE-2.0", 32 | "bugs": { 33 | "url": "https://github.com/node-casbin/koa-authz/issues" 34 | }, 35 | "homepage": "https://github.com/node-casbin/koa-authz#readme", 36 | "dependencies": {}, 37 | "devDependencies": { 38 | "casbin": "^3.0.0", 39 | "coveralls": "^3.0.2", 40 | "eslint": "^5.4.0", 41 | "eslint-config-standard": "^11.0.0", 42 | "eslint-plugin-import": "^2.14.0", 43 | "eslint-plugin-node": "^7.0.1", 44 | "eslint-plugin-promise": "^4.0.0", 45 | "eslint-plugin-standard": "^3.1.0", 46 | "express": "^4.16.3", 47 | "jest": "^23.5.0", 48 | "koa": "^2.5.2", 49 | "supertest": "^3.1.0" 50 | }, 51 | "peerDependencies": { 52 | "casbin": "^3.0.0" 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /test/customize.test.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018 The Casbin Authors. All Rights Reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | const app = require('./customizeServer') 16 | const request = require('supertest')(app) 17 | 18 | afterAll(() => { 19 | app.close() 20 | }) 21 | 22 | it('customize authorizer tests', async () => { 23 | const response = await request 24 | .get('/dataset1/name') 25 | .set('Authorization', 'alice') 26 | expect(response.statusCode).toBe(200) 27 | }) 28 | -------------------------------------------------------------------------------- /test/customizeServer.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018 The Casbin Authors. All Rights Reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | const Koa = require('koa') 16 | const casbin = require('casbin') 17 | const authz = require('../authz') 18 | const app = new Koa() 19 | const BasicAuthorizer = require('../BasicAuthorizer') 20 | 21 | // set userinfo 22 | app.use(async (ctx, next) => { 23 | try { 24 | const username = ctx.get('Authorization') || 'anonymous' 25 | ctx.state.user = {username} 26 | await next() 27 | ctx.body = {status: true} 28 | } catch (e) { 29 | ctx.status = 503 30 | } 31 | }) 32 | 33 | // use CustomizeAuthorizer 34 | class CustomizeAuthorizer extends BasicAuthorizer { 35 | // override function 36 | getUserName () { 37 | const { username } = this.ctx.state.user 38 | return username 39 | } 40 | // checkPermission () { 41 | // const {ctx, enforcer} = this 42 | // const {originalUrl: path, method} = ctx 43 | // const user = this.getUserName() 44 | // return enforcer.enforce(user, path, method) 45 | // } 46 | } 47 | 48 | app.use(authz({ 49 | newEnforcer: async () => { 50 | // load the casbin model and policy from files, database is also supported. 51 | const enforcer = await casbin.newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv') 52 | return enforcer 53 | }, 54 | authorizer: (ctx, option) => new CustomizeAuthorizer(ctx, option) 55 | })) 56 | 57 | module.exports = app.listen(3001) 58 | -------------------------------------------------------------------------------- /test/server.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018 The Casbin Authors. All Rights Reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | const Koa = require('koa') 16 | const casbin = require('casbin') 17 | const authz = require('../authz') 18 | 19 | const app = new Koa() 20 | 21 | // set userinfo 22 | app.use(async (ctx, next) => { 23 | try { 24 | const username = ctx.get('Authorization') || 'anonymous' 25 | ctx.user = {username} 26 | await next() 27 | ctx.body = {status: true} 28 | } catch (e) { 29 | ctx.status = 503 30 | } 31 | }) 32 | // use authz middleware 33 | app.use(authz({ 34 | newEnforcer: async () => { 35 | // load the casbin model and policy from files, database is also supported. 36 | const enforcer = await casbin.newEnforcer('examples/authz_model.conf', 'examples/authz_policy.csv') 37 | return enforcer 38 | } 39 | })) 40 | 41 | module.exports = app.listen(3000) 42 | -------------------------------------------------------------------------------- /test/test.js: -------------------------------------------------------------------------------- 1 | // Copyright 2018 The Casbin Authors. All Rights Reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | const app = require('./server') 16 | const request = require('supertest')(app) 17 | 18 | afterAll(() => { 19 | app.close() 20 | }) 21 | 22 | describe('pass through tests', () => { 23 | it('test: p, alice, /dataset1/*, GET', async () => { 24 | const response = await request 25 | .get('/dataset1/name') 26 | .set('Authorization', 'alice') 27 | expect(response.statusCode).toBe(200) 28 | }) 29 | 30 | it('test: p, alice, /dataset1/resource1, POST', async () => { 31 | const response = await request 32 | .post('/dataset1/resource1') 33 | .set('Authorization', 'alice') 34 | expect(response.statusCode).toBe(200) 35 | }) 36 | 37 | it('test: bob, /dataset2/folder1/*, POST', async () => { 38 | const response = await request 39 | .post('/dataset2/folder1/file') 40 | .set('Authorization', 'bob') 41 | expect(response.statusCode).toBe(200) 42 | }) 43 | 44 | it('test: p, bob, /dataset2/resource1, * - GET', async () => { 45 | const response = await request 46 | .get('/dataset2/resource1') 47 | .set('Authorization', 'bob') 48 | expect(response.statusCode).toBe(200) 49 | }) 50 | 51 | it('test: p, bob, /dataset2/resource1, * - POST', async () => { 52 | const response = await request 53 | .post('/dataset2/resource1') 54 | .set('Authorization', 'bob') 55 | expect(response.statusCode).toBe(200) 56 | }) 57 | 58 | it('test: p, bob, /dataset2/resource1, * - PUT', async () => { 59 | const response = await request 60 | .put('/dataset2/resource1') 61 | .set('Authorization', 'bob') 62 | expect(response.statusCode).toBe(200) 63 | }) 64 | 65 | it('test: p, bob, /dataset2/resource1, * - DELETE', async () => { 66 | const response = await request 67 | .delete('/dataset2/resource1') 68 | .set('Authorization', 'bob') 69 | expect(response.statusCode).toBe(200) 70 | }) 71 | 72 | it('test: p, bob, /dataset2/resource2, GET', async () => { 73 | const response = await request 74 | .get('/dataset2/resource2') 75 | .set('Authorization', 'bob') 76 | expect(response.statusCode).toBe(200) 77 | }) 78 | 79 | it('test: p & g, dataset1_admin, /dataset1/*, * - GET', async () => { 80 | const response = await request 81 | .get('/dataset1/resource') 82 | .set('Authorization', 'cathy') 83 | expect(response.statusCode).toBe(200) 84 | }) 85 | 86 | it('test: p & g, dataset1_admin, /dataset1/*, * - POST', async () => { 87 | const response = await request 88 | .post('/dataset1/resource') 89 | .set('Authorization', 'cathy') 90 | expect(response.statusCode).toBe(200) 91 | }) 92 | 93 | it('test: p & g, dataset1_admin, /dataset1/*, * - PUT', async () => { 94 | const response = await request 95 | .put('/dataset1/resource') 96 | .set('Authorization', 'cathy') 97 | expect(response.statusCode).toBe(200) 98 | }) 99 | 100 | it('test: p & g, dataset1_admin, /dataset1/*, * - DELETE', async () => { 101 | const response = await request 102 | .delete('/dataset1/resource') 103 | .set('Authorization', 'cathy') 104 | expect(response.statusCode).toBe(200) 105 | }) 106 | }) 107 | 108 | describe('success through tests', () => { 109 | it('test: p, alice, /dataset1/*, GET - 403', async () => { 110 | const response = await request 111 | .post('/dataset1/users') 112 | .set('Authorization', 'alice') 113 | expect(response.statusCode).toBe(403) 114 | }) 115 | 116 | it('test: p, alice, /dataset1/resource1, POST - 403', async () => { 117 | const response = await request 118 | .post('/dataset1/resource') 119 | .set('Authorization', 'alice') 120 | expect(response.statusCode).toBe(403) 121 | }) 122 | 123 | it('test: bob, /dataset2/folder1/*, POST', async () => { 124 | const response = await request 125 | .put('/dataset2/folder1/file') 126 | .set('Authorization', 'bob') 127 | expect(response.statusCode).toBe(403) 128 | }) 129 | 130 | it('test: p, bob, /dataset2/resource1, * - GET', async () => { 131 | const response = await request 132 | .get('/dataset2/resource') 133 | .set('Authorization', 'bob') 134 | expect(response.statusCode).toBe(403) 135 | }) 136 | 137 | it('test: p, bob, /dataset2/resource1, * - POST', async () => { 138 | const response = await request 139 | .post('/dataset2/resource') 140 | .set('Authorization', 'bob') 141 | expect(response.statusCode).toBe(403) 142 | }) 143 | 144 | it('test: p, bob, /dataset2/resource1, * - PUT', async () => { 145 | const response = await request 146 | .put('/dataset2/resource') 147 | .set('Authorization', 'bob') 148 | expect(response.statusCode).toBe(403) 149 | }) 150 | 151 | it('test: p, bob, /dataset2/resource1, * - DELETE', async () => { 152 | const response = await request 153 | .delete('/dataset2/resource') 154 | .set('Authorization', 'bob') 155 | expect(response.statusCode).toBe(403) 156 | }) 157 | 158 | it('test: p, bob, /dataset2/resource2, GET', async () => { 159 | const response = await request 160 | .post('/dataset2/resource2') 161 | .set('Authorization', 'bob') 162 | expect(response.statusCode).toBe(403) 163 | }) 164 | 165 | it('test: p & g, dataset1_admin, /dataset1/*, * - GET', async () => { 166 | const response = await request 167 | .get('/dataset1/resource') 168 | .set('Authorization', 'chalin') 169 | expect(response.statusCode).toBe(403) 170 | }) 171 | 172 | it('test: p & g, dataset1_admin, /dataset1/*, * - POST', async () => { 173 | const response = await request 174 | .post('/dataset1/resource') 175 | .set('Authorization', 'chalin') 176 | expect(response.statusCode).toBe(403) 177 | }) 178 | 179 | it('test: p & g, dataset1_admin, /dataset1/*, * - PUT', async () => { 180 | const response = await request 181 | .put('/dataset1/resource') 182 | .set('Authorization', 'chalin') 183 | expect(response.statusCode).toBe(403) 184 | }) 185 | 186 | it('test: p & g, dataset1_admin, /dataset1/*, * - DELETE', async () => { 187 | const response = await request 188 | .delete('/dataset1/resource') 189 | .set('Authorization', 'chalin') 190 | expect(response.statusCode).toBe(403) 191 | }) 192 | }) 193 | --------------------------------------------------------------------------------