├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── adapter.go ├── adapter_test.go ├── examples ├── rbac_model.conf └── rbac_policy.csv ├── go.mod └── go.sum /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.dll 4 | *.so 5 | *.dylib 6 | 7 | # Test binary, build with `go test -c` 8 | *.test 9 | 10 | # Output of the go coverage tool, specifically when used with LiteIDE 11 | *.out 12 | 13 | # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 14 | .glide/ 15 | 16 | .idea/ 17 | *.iml -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | sudo: false 4 | 5 | go: 6 | - tip 7 | 8 | before_install: 9 | - go get github.com/mattn/goveralls 10 | 11 | before_script: 12 | - mysql -e 'CREATE DATABASE casbin;' 13 | - psql -c 'CREATE DATABASE casbin;' -U postgres 14 | 15 | script: 16 | - $HOME/gopath/bin/goveralls -service=travis-ci 17 | 18 | services: 19 | - mysql 20 | - postgresql -------------------------------------------------------------------------------- /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 | gdb adapter [![Build Status](https://travis-ci.org/vance-liu/gdb-adapter.svg?branch=master)](https://travis-ci.org/vance-liu/gdb-adapter) [![Coverage Status](https://coveralls.io/repos/github/vance-liu/gdb-adapter/badge.svg?branch=master)](https://coveralls.io/github/vance-liu/gdb-adapter?branch=master) [![Godoc](https://godoc.org/github.com/vance-liu/gdb-adapter?status.svg)](https://godoc.org/github.com/vance-liu/gdb-adapter) 2 | ==== 3 | 4 | [GF ORM](https://github.com/gogf/gf) adapter for [Casbin](https://github.com/casbin/casbin). 5 | 6 | Based on [GF ORM](https://github.com/gogf/gf), and tested in: 7 | - MySQL 8 | - PostgreSQL 9 | 10 | ## Installation 11 | 12 | go get github.com/vance-liu/gdb-adapter 13 | 14 | ## Usage example 15 | 16 | ```go 17 | opts := &Adapter{ 18 | DriverName: "mysql", 19 | DataSourceName: "root:1234@tcp(127.0.0.1:3306)/casbin", 20 | TableName: "casbin_rule", 21 | // or reuse an existing connection: 22 | // Db: yourDBConn, 23 | } 24 | 25 | a := NewAdapterFromOptions(opts) 26 | e := casbin.NewEnforcer("examples/rbac_model.conf", a) 27 | ``` 28 | 29 | ## Notice 30 | you should create the database on your own. 31 | 32 | ## Getting Help 33 | 34 | - [Casbin](https://github.com/casbin/casbin) 35 | 36 | ## License 37 | 38 | This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text. 39 | -------------------------------------------------------------------------------- /adapter.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 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 | package gdbadapter 16 | 17 | import ( 18 | "fmt" 19 | "runtime" 20 | 21 | "github.com/gogf/gf/database/gdb" 22 | 23 | "github.com/casbin/casbin/v2/model" 24 | "github.com/casbin/casbin/v2/persist" 25 | ) 26 | 27 | type CasbinRule struct { 28 | PType string `json:"ptype"` 29 | V0 string `json:"v0"` 30 | V1 string `json:"v1"` 31 | V2 string `json:"v2"` 32 | V3 string `json:"v3"` 33 | V4 string `json:"v4"` 34 | V5 string `json:"v5"` 35 | } 36 | 37 | // Adapter represents the gdb adapter for policy storage. 38 | type Adapter struct { 39 | DriverName string 40 | DataSourceName string 41 | TableName string 42 | Db gdb.DB 43 | } 44 | 45 | // finalizer is the destructor for Adapter. 46 | func finalizer(a *Adapter) { 47 | // 注意不用的时候不需要使用Close方法关闭数据库连接(并且gdb也没有提供Close方法)， 48 | // 数据库引擎底层采用了链接池设计，当链接不再使用时会自动关闭 49 | a.Db = nil 50 | } 51 | 52 | // NewAdapter is the constructor for Adapter. 53 | func NewAdapter(driverName string, dataSourceName string) (*Adapter, error) { 54 | a := &Adapter{} 55 | a.DriverName = driverName 56 | a.DataSourceName = dataSourceName 57 | a.TableName = "casbin_rule" 58 | 59 | // Open the DB, create it if not existed. 60 | err := a.open() 61 | if err != nil { 62 | return nil, err 63 | } 64 | 65 | // Call the destructor when the object is released. 66 | runtime.SetFinalizer(a, finalizer) 67 | 68 | return a, nil 69 | } 70 | 71 | // NewAdapterFromOptions is the constructor for Adapter with existed connection 72 | func NewAdapterFromOptions(adapter *Adapter) (*Adapter, error) { 73 | 74 | if adapter.TableName == "" { 75 | adapter.TableName = "casbin_rule" 76 | } 77 | if adapter.Db == nil { 78 | err := adapter.open() 79 | if err != nil { 80 | return nil, err 81 | } 82 | 83 | runtime.SetFinalizer(adapter, finalizer) 84 | } 85 | return adapter, nil 86 | } 87 | 88 | func (a *Adapter) open() error { 89 | var err error 90 | var db gdb.DB 91 | 92 | gdb.SetConfig(gdb.Config{ 93 | "casbin": gdb.ConfigGroup{ 94 | gdb.ConfigNode{ 95 | Type: a.DriverName, 96 | Link: a.DataSourceName, 97 | Role: "master", 98 | Weight: 100, 99 | }, 100 | }, 101 | }) 102 | db, err = gdb.New("casbin") 103 | 104 | if err != nil { 105 | return err 106 | } 107 | 108 | a.Db = db 109 | 110 | return a.createTable() 111 | } 112 | 113 | func (a *Adapter) close() error { 114 | // 注意不用的时候不需要使用Close方法关闭数据库连接(并且gdb也没有提供Close方法)， 115 | // 数据库引擎底层采用了链接池设计，当链接不再使用时会自动关闭 116 | a.Db = nil 117 | return nil 118 | } 119 | 120 | func (a *Adapter) createTable() error { 121 | _, err := a.Db.Exec(fmt.Sprintf("CREATE TABLE IF NOT EXISTS %s (ptype VARCHAR(10), v0 VARCHAR(256), v1 VARCHAR(256), v2 VARCHAR(256), v3 VARCHAR(256), v4 VARCHAR(256), v5 VARCHAR(256))", a.TableName)) 122 | return err 123 | } 124 | 125 | func (a *Adapter) dropTable() error { 126 | _, err := a.Db.Exec(fmt.Sprintf("DROP TABLE %s", a.TableName)) 127 | return err 128 | } 129 | 130 | func loadPolicyLine(line CasbinRule, model model.Model) { 131 | lineText := line.PType 132 | if line.V0 != "" { 133 | lineText += ", " + line.V0 134 | } 135 | if line.V1 != "" { 136 | lineText += ", " + line.V1 137 | } 138 | if line.V2 != "" { 139 | lineText += ", " + line.V2 140 | } 141 | if line.V3 != "" { 142 | lineText += ", " + line.V3 143 | } 144 | if line.V4 != "" { 145 | lineText += ", " + line.V4 146 | } 147 | if line.V5 != "" { 148 | lineText += ", " + line.V5 149 | } 150 | 151 | persist.LoadPolicyLine(lineText, model) 152 | } 153 | 154 | // LoadPolicy loads policy from database. 155 | func (a *Adapter) LoadPolicy(model model.Model) error { 156 | var lines []CasbinRule 157 | 158 | if err := a.Db.Table(a.TableName).Scan(&lines); err != nil { 159 | return err 160 | } 161 | 162 | for _, line := range lines { 163 | loadPolicyLine(line, model) 164 | } 165 | 166 | return nil 167 | } 168 | 169 | func savePolicyLine(ptype string, rule []string) CasbinRule { 170 | line := CasbinRule{} 171 | 172 | line.PType = ptype 173 | if len(rule) > 0 { 174 | line.V0 = rule[0] 175 | } 176 | if len(rule) > 1 { 177 | line.V1 = rule[1] 178 | } 179 | if len(rule) > 2 { 180 | line.V2 = rule[2] 181 | } 182 | if len(rule) > 3 { 183 | line.V3 = rule[3] 184 | } 185 | if len(rule) > 4 { 186 | line.V4 = rule[4] 187 | } 188 | if len(rule) > 5 { 189 | line.V5 = rule[5] 190 | } 191 | 192 | return line 193 | } 194 | 195 | // SavePolicy saves policy to database. 196 | func (a *Adapter) SavePolicy(model model.Model) error { 197 | err := a.dropTable() 198 | if err != nil { 199 | return err 200 | } 201 | err = a.createTable() 202 | if err != nil { 203 | return err 204 | } 205 | 206 | for ptype, ast := range model["p"] { 207 | for _, rule := range ast.Policy { 208 | line := savePolicyLine(ptype, rule) 209 | _, err := a.Db.Table(a.TableName).Data(&line).Insert() 210 | if err != nil { 211 | return err 212 | } 213 | } 214 | } 215 | 216 | for ptype, ast := range model["g"] { 217 | for _, rule := range ast.Policy { 218 | line := savePolicyLine(ptype, rule) 219 | _, err := a.Db.Table(a.TableName).Data(&line).Insert() 220 | if err != nil { 221 | return err 222 | } 223 | } 224 | } 225 | 226 | return nil 227 | } 228 | 229 | // AddPolicy adds a policy rule to the storage. 230 | func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error { 231 | line := savePolicyLine(ptype, rule) 232 | _, err := a.Db.Table(a.TableName).Data(&line).Insert() 233 | return err 234 | } 235 | 236 | // RemovePolicy removes a policy rule from the storage. 237 | func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error { 238 | line := savePolicyLine(ptype, rule) 239 | err := rawDelete(a, line) 240 | return err 241 | } 242 | 243 | // RemoveFilteredPolicy removes policy rules that match the filter from the storage. 244 | func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error { 245 | line := CasbinRule{} 246 | 247 | line.PType = ptype 248 | if fieldIndex <= 0 && 0 < fieldIndex+len(fieldValues) { 249 | line.V0 = fieldValues[0-fieldIndex] 250 | } 251 | if fieldIndex <= 1 && 1 < fieldIndex+len(fieldValues) { 252 | line.V1 = fieldValues[1-fieldIndex] 253 | } 254 | if fieldIndex <= 2 && 2 < fieldIndex+len(fieldValues) { 255 | line.V2 = fieldValues[2-fieldIndex] 256 | } 257 | if fieldIndex <= 3 && 3 < fieldIndex+len(fieldValues) { 258 | line.V3 = fieldValues[3-fieldIndex] 259 | } 260 | if fieldIndex <= 4 && 4 < fieldIndex+len(fieldValues) { 261 | line.V4 = fieldValues[4-fieldIndex] 262 | } 263 | if fieldIndex <= 5 && 5 < fieldIndex+len(fieldValues) { 264 | line.V5 = fieldValues[5-fieldIndex] 265 | } 266 | err := rawDelete(a, line) 267 | return err 268 | } 269 | 270 | func rawDelete(a *Adapter, line CasbinRule) error { 271 | db := a.Db.Table(a.TableName) 272 | 273 | db.Where("ptype = ?", line.PType) 274 | if line.V0 != "" { 275 | db.Where("v0 = ?", line.V0) 276 | } 277 | if line.V1 != "" { 278 | db.Where("v1 = ?", line.V1) 279 | } 280 | if line.V2 != "" { 281 | db.Where("v2 = ?", line.V2) 282 | } 283 | if line.V3 != "" { 284 | db.Where("v3 = ?", line.V3) 285 | } 286 | if line.V4 != "" { 287 | db.Where("v4 = ?", line.V4) 288 | } 289 | if line.V5 != "" { 290 | db.Where("v5 = ?", line.V5) 291 | } 292 | 293 | _, err := db.Delete() 294 | return err 295 | } 296 | -------------------------------------------------------------------------------- /adapter_test.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 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 | package gdbadapter 16 | 17 | import ( 18 | "log" 19 | "testing" 20 | 21 | "github.com/casbin/casbin/v2" 22 | "github.com/casbin/casbin/v2/util" 23 | _ "github.com/go-sql-driver/mysql" 24 | _ "github.com/lib/pq" 25 | ) 26 | 27 | func testGetPolicy(t *testing.T, e *casbin.Enforcer, res [][]string) { 28 | myRes := e.GetPolicy() 29 | log.Print("Policy: ", myRes) 30 | 31 | if !util.Array2DEquals(res, myRes) { 32 | t.Error("Policy: ", myRes, ", supposed to be ", res) 33 | } 34 | } 35 | 36 | func initPolicy(t *testing.T, a *Adapter) { 37 | // Because the DB is empty at first, 38 | // so we need to load the policy from the file adapter (.CSV) first. 39 | e, err := casbin.NewEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv") 40 | if err != nil { 41 | panic(err) 42 | } 43 | 44 | // This is a trick to save the current policy to the DB. 45 | // We can't call e.SavePolicy() because the adapter in the enforcer is still the file adapter. 46 | // The current policy means the policy in the Casbin enforcer (aka in memory). 47 | err = a.SavePolicy(e.GetModel()) 48 | if err != nil { 49 | panic(err) 50 | } 51 | 52 | // Clear the current policy. 53 | e.ClearPolicy() 54 | testGetPolicy(t, e, [][]string{}) 55 | 56 | // Load the policy from DB. 57 | err = a.LoadPolicy(e.GetModel()) 58 | if err != nil { 59 | panic(err) 60 | } 61 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}}) 62 | } 63 | 64 | func testSaveLoad(t *testing.T, a *Adapter) { 65 | // Initialize some policy in DB. 66 | initPolicy(t, a) 67 | // Note: you don't need to look at the above code 68 | // if you already have a working DB with policy inside. 69 | 70 | // Now the DB has policy, so we can provide a normal use case. 71 | // Create an adapter and an enforcer. 72 | // NewEnforcer() will load the policy automatically. 73 | 74 | e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a) 75 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}}) 76 | } 77 | 78 | func initAdapter(t *testing.T, driverName string, dataSourceName string) *Adapter { 79 | // Create an adapter 80 | a, err := NewAdapter(driverName, dataSourceName) 81 | if err != nil { 82 | panic(err) 83 | } 84 | 85 | // Initialize some policy in DB. 86 | initPolicy(t, a) 87 | // Now the DB has policy, so we can provide a normal use case. 88 | // Note: you don't need to look at the above code 89 | // if you already have a working DB with policy inside. 90 | 91 | return a 92 | } 93 | 94 | func initAdapterFormOptions(t *testing.T, adapter *Adapter) *Adapter { 95 | // Create an adapter 96 | a, _ := NewAdapterFromOptions(adapter) 97 | // Initialize some policy in DB. 98 | initPolicy(t, a) 99 | // Now the DB has policy, so we can provide a normal use case. 100 | // Note: you don't need to look at the above code 101 | // if you already have a working DB with policy inside. 102 | 103 | return a 104 | } 105 | 106 | func testAutoSave(t *testing.T, a *Adapter) { 107 | 108 | // NewEnforcer() will load the policy automatically. 109 | e, _ := casbin.NewEnforcer("examples/rbac_model.conf", a) 110 | // AutoSave is enabled by default. 111 | // Now we disable it. 112 | e.EnableAutoSave(false) 113 | 114 | // Because AutoSave is disabled, the policy change only affects the policy in Casbin enforcer, 115 | // it doesn't affect the policy in the storage. 116 | e.AddPolicy("alice", "data1", "write") 117 | // Reload the policy from the storage to see the effect. 118 | e.LoadPolicy() 119 | // This is still the original policy. 120 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}}) 121 | 122 | // Now we enable the AutoSave. 123 | e.EnableAutoSave(true) 124 | 125 | // Because AutoSave is enabled, the policy change not only affects the policy in Casbin enforcer, 126 | // but also affects the policy in the storage. 127 | e.AddPolicy("alice", "data1", "write") 128 | // Reload the policy from the storage to see the effect. 129 | e.LoadPolicy() 130 | // The policy has a new rule: {"alice", "data1", "write"}. 131 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}, {"alice", "data1", "write"}}) 132 | 133 | // Remove the added rule. 134 | e.RemovePolicy("alice", "data1", "write") 135 | e.LoadPolicy() 136 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}}) 137 | 138 | // Remove "data2_admin" related policy rules via a filter. 139 | // Two rules: {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"} are deleted. 140 | e.RemoveFilteredPolicy(0, "data2_admin") 141 | e.LoadPolicy() 142 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}}) 143 | } 144 | 145 | func TestAdapters(t *testing.T) { 146 | a := initAdapter(t, "mysql", "root:@tcp(127.0.0.1:3306)/casbin") 147 | testAutoSave(t, a) 148 | testSaveLoad(t, a) 149 | 150 | a = initAdapter(t, "pgsql", "user=postgres host=127.0.0.1 port=5432 sslmode=disable dbname=casbin") 151 | testAutoSave(t, a) 152 | testSaveLoad(t, a) 153 | 154 | a = initAdapterFormOptions(t, &Adapter{ 155 | DriverName: "mysql", 156 | DataSourceName: "root:@tcp(127.0.0.1:3306)/casbin", 157 | }) 158 | testAutoSave(t, a) 159 | testSaveLoad(t, a) 160 | 161 | a = initAdapterFormOptions(t, &Adapter{ 162 | DriverName: "pgsql", 163 | DataSourceName: "user=postgres host=127.0.0.1 port=5432 sslmode=disable dbname=casbin", 164 | }) 165 | testAutoSave(t, a) 166 | testSaveLoad(t, a) 167 | } 168 | -------------------------------------------------------------------------------- /examples/rbac_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) && r.obj == p.obj && r.act == p.act -------------------------------------------------------------------------------- /examples/rbac_policy.csv: -------------------------------------------------------------------------------- 1 | p, alice, data1, read 2 | p, bob, data2, write 3 | p, data2_admin, data2, read 4 | p, data2_admin, data2, write 5 | g, alice, data2_admin -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/vance-liu/gdb-adapter 2 | 3 | go 1.16 4 | 5 | require ( 6 | github.com/casbin/casbin/v2 v2.34.0 7 | github.com/davecgh/go-spew v1.1.1 // indirect 8 | github.com/go-sql-driver/mysql v1.6.0 9 | github.com/gogf/gf v1.16.4 10 | github.com/lib/pq v1.10.2 11 | github.com/mattn/go-runewidth v0.0.13 // indirect 12 | ) 13 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= 2 | github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= 3 | github.com/Knetic/govaluate v3.0.1-0.20171022003610-9aa49832a739+incompatible h1:1G1pk05UrOh0NlF1oeaaix1x8XzrfjIDK47TY0Zehcw= 4 | github.com/Knetic/govaluate v3.0.1-0.20171022003610-9aa49832a739+incompatible/go.mod h1:r7JcOSlj0wfOMncg0iLm8Leh48TZaKVeNIfJntJ2wa0= 5 | github.com/casbin/casbin/v2 v2.0.0 h1:OIcnP8SxwF1gmGxOn7Kod/O/7yJikpHWQz0qiBJpG/U= 6 | github.com/casbin/casbin/v2 v2.0.0/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ= 7 | github.com/casbin/casbin/v2 v2.34.0 h1:b5WL+VXBhaeKni02SXVqQPRN2+zDZLturqxe1ARmVas= 8 | github.com/casbin/casbin/v2 v2.34.0/go.mod h1:vByNa/Fchek0KZUgG5wEsl7iFsiviAYKRtgrQfcJqHg= 9 | github.com/clbanning/mxj v1.8.5-0.20200714211355-ff02cfb8ea28 h1:LdXxtjzvZYhhUaonAaAKArG3pyC67kGL3YY+6hGG8G4= 10 | github.com/clbanning/mxj v1.8.5-0.20200714211355-ff02cfb8ea28/go.mod h1:BVjHeAH+rl9rs6f+QIpeRl0tfu10SXn1pUSa5PVGJng= 11 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 12 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 13 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 14 | github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= 15 | github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= 16 | github.com/go-sql-driver/mysql v1.5.0 h1:ozyZYNQW3x3HtqT1jira07DN2PArx2v7/mN66gGcHOs= 17 | github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= 18 | github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE= 19 | github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= 20 | github.com/gogf/gf v1.15.3 h1:Nbm/ta3zL8vVgm/7prpvVrtUWlsSZDqykuuY9lGa6JI= 21 | github.com/gogf/gf v1.15.3/go.mod h1:K3FG9L4JBUeNLxQR/jCzDgB9+G9sayn49uQwx2zAn4A= 22 | github.com/gogf/gf v1.16.4 h1:1Y8/P1UMp9BmrtUn0wAg3g6ElRAO0R9QHCdUNt9Z5L4= 23 | github.com/gogf/gf v1.16.4/go.mod h1:EjnxZXddTwfFoLPofDE3NokFWx+immofINtSyFCj280= 24 | github.com/gogf/mysql v1.6.1-0.20210603073548-16164ae25579 h1:pP/uEy52biKDytlgK/ug8kiYPAiYu6KajKVUHfGrtyw= 25 | github.com/gogf/mysql v1.6.1-0.20210603073548-16164ae25579/go.mod h1:52e6mXyNnHAsFrXrSnj5JPRSKsZKpHylVtA3j4AtMz8= 26 | github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4= 27 | github.com/gomodule/redigo v2.0.0+incompatible h1:K/R+8tc58AaqLkqG2Ol3Qk+DR/TlNuhuh457pBFPtt0= 28 | github.com/gomodule/redigo v2.0.0+incompatible/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4= 29 | github.com/google/go-cmp v0.5.4 h1:L8R9j+yAqZuZjsqh/z+F1NCffTKKLShY6zXTItVIZ8M= 30 | github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= 31 | github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= 32 | github.com/gorilla/websocket v1.4.1 h1:q7AeDBpnBk8AogcD4DSag/Ukw/KV+YhzLj2bP5HvKCM= 33 | github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= 34 | github.com/grokify/html-strip-tags-go v0.0.0-20190921062105-daaa06bf1aaf h1:wIOAyJMMen0ELGiFzlmqxdcV1yGbkyHBAB6PolcNbLA= 35 | github.com/grokify/html-strip-tags-go v0.0.0-20190921062105-daaa06bf1aaf/go.mod h1:2Su6romC5/1VXOQMaWL2yb618ARB8iVo6/DR99A6d78= 36 | github.com/lib/pq v1.1.1 h1:sJZmqHoEaY7f+NPP8pgLB/WxulyR3fewgCM2qaSlBb4= 37 | github.com/lib/pq v1.1.1/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= 38 | github.com/lib/pq v1.10.2 h1:AqzbZs4ZoCBp+GtejcpCpcxM3zlSMx29dXbUSeVtJb8= 39 | github.com/lib/pq v1.10.2/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= 40 | github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= 41 | github.com/mattn/go-runewidth v0.0.10 h1:CoZ3S2P7pvtP45xOtBw+/mDL2z0RKI576gSkzRRpdGg= 42 | github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= 43 | github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU= 44 | github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= 45 | github.com/olekukonko/tablewriter v0.0.1 h1:b3iUnf1v+ppJiOfNX4yxxqfWKMQPZR5yoh8urCTFX88= 46 | github.com/olekukonko/tablewriter v0.0.1/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo= 47 | github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY= 48 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 49 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 50 | github.com/rivo/uniseg v0.1.0 h1:+2KBaVoUmb9XzDsrx/Ct0W/EYOSFf/nWTauy++DprtY= 51 | github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= 52 | github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= 53 | github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= 54 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 55 | github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= 56 | github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 57 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 58 | go.opentelemetry.io/otel v0.16.0 h1:uIWEbdeb4vpKPGITLsRVUS44L5oDbDUCZxn8lkxhmgw= 59 | go.opentelemetry.io/otel v0.16.0/go.mod h1:e4GKElweB8W2gWUqbghw0B8t5MCTccc9212eNHnOHwA= 60 | go.opentelemetry.io/otel v0.19.0 h1:Lenfy7QHRXPZVsw/12CWpxX6d/JkrX8wrx2vO8G80Ng= 61 | go.opentelemetry.io/otel v0.19.0/go.mod h1:j9bF567N9EfomkSidSfmMwIwIBuP37AMAIzVW85OxSg= 62 | go.opentelemetry.io/otel/metric v0.19.0 h1:dtZ1Ju44gkJkYvo+3qGqVXmf88tc+a42edOywypengg= 63 | go.opentelemetry.io/otel/metric v0.19.0/go.mod h1:8f9fglJPRnXuskQmKpnad31lcLJ2VmNNqIsx/uIwBSc= 64 | go.opentelemetry.io/otel/oteltest v0.19.0/go.mod h1:tI4yxwh8U21v7JD6R3BcA/2+RBoTKFexE/PJ/nSO7IA= 65 | go.opentelemetry.io/otel/trace v0.19.0 h1:1ucYlenXIDA1OlHVLDZKX0ObXV5RLaq06DtUKz5e5zc= 66 | go.opentelemetry.io/otel/trace v0.19.0/go.mod h1:4IXiNextNOpPnRlI4ryK69mn5iC84bjBWZQA5DXz/qg= 67 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 68 | golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= 69 | golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 70 | golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 71 | golang.org/x/net v0.0.0-20201031054903-ff519b6c9102 h1:42cLlJJdEh+ySyeUUbEQ5bsTiq8voBeTuweGVkY6Puw= 72 | golang.org/x/net v0.0.0-20201031054903-ff519b6c9102/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= 73 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 74 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 75 | golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 76 | golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 77 | golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f h1:+Nyd8tzPX9R7BWHguqsrbFdRx3WQ/1ib8I44HXV5yTA= 78 | golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 79 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 80 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 81 | golang.org/x/text v0.3.4 h1:0YWbFKbhXG/wIiuHDSKpS0Iy7FSA+u45VtBMfQcFTTc= 82 | golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 83 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 84 | golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= 85 | golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= 86 | golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 87 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 88 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 89 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= 90 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 91 | --------------------------------------------------------------------------------