├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── adapter.go ├── adapter_test.go └── examples ├── rbac_model.conf └── rbac_policy.csv /.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 | script: 12 | - $HOME/gopath/bin/goveralls -service=travis-ci 13 | 14 | services: 15 | - mysql -------------------------------------------------------------------------------- /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 | MySQL Adapter [![Build Status](https://travis-ci.org/casbin/mysql-adapter.svg?branch=master)](https://travis-ci.org/casbin/mysql-adapter) [![Coverage Status](https://coveralls.io/repos/github/casbin/mysql-adapter/badge.svg?branch=master)](https://coveralls.io/github/casbin/mysql-adapter?branch=master) [![Godoc](https://godoc.org/github.com/casbin/mysql-adapter?status.svg)](https://godoc.org/github.com/casbin/mysql-adapter) 2 | ==== 3 | 4 | MySQL Adapter is the [MySQL DB](https://www.mysql.com/) adapter for [Casbin](https://github.com/casbin/casbin). With this library, Casbin can load policy from MySQL or save policy to it. 5 | 6 | ## Installation 7 | 8 | go get github.com/casbin/mysql-adapter 9 | 10 | ## Simple Example 11 | 12 | ```go 13 | package main 14 | 15 | import ( 16 | "github.com/casbin/casbin" 17 | "github.com/casbin/mysql-adapter" 18 | ) 19 | 20 | func main() { 21 | // Initialize a MySQL adapter and use it in a Casbin enforcer: 22 | // The adapter will use the database named casbin. 23 | // If it doesn't exist, the adapter will create it automatically. 24 | a := mysqladapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/") // Your MySQL driver and data source. 25 | e := casbin.NewEnforcer("examples/rbac_model.conf", a) 26 | 27 | // Load the policy from DB. 28 | e.LoadPolicy() 29 | 30 | // Check the permission. 31 | e.Enforce("alice", "data1", "read") 32 | 33 | // Modify the policy. 34 | // e.AddPolicy(...) 35 | // e.RemovePolicy(...) 36 | 37 | // Save the policy back to DB. 38 | e.SavePolicy() 39 | } 40 | ``` 41 | 42 | ## Getting Help 43 | 44 | - [Casbin](https://github.com/casbin/casbin) 45 | 46 | ## License 47 | 48 | This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text. 49 | -------------------------------------------------------------------------------- /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 mysqladapter 16 | 17 | import ( 18 | "database/sql" 19 | "errors" 20 | "strings" 21 | 22 | "github.com/casbin/casbin/model" 23 | _ "github.com/go-sql-driver/mysql" // This is for MySQL initialization. 24 | ) 25 | 26 | // Adapter represents the MySQL adapter for policy storage. 27 | type Adapter struct { 28 | driverName string 29 | dataSourceName string 30 | db *sql.DB 31 | } 32 | 33 | // NewAdapter is the constructor for Adapter. 34 | func NewAdapter(driverName string, dataSourceName string) *Adapter { 35 | a := Adapter{} 36 | a.driverName = driverName 37 | a.dataSourceName = dataSourceName 38 | return &a 39 | } 40 | 41 | func (a *Adapter) createDatabase() error { 42 | db, err := sql.Open(a.driverName, a.dataSourceName) 43 | if err != nil { 44 | return err 45 | } 46 | defer db.Close() 47 | 48 | _, err = db.Exec("CREATE DATABASE IF NOT EXISTS casbin") 49 | return err 50 | } 51 | 52 | func (a *Adapter) open() { 53 | if err := a.createDatabase(); err != nil { 54 | panic(err) 55 | } 56 | 57 | db, err := sql.Open(a.driverName, a.dataSourceName+"casbin") 58 | if err != nil { 59 | panic(err) 60 | } 61 | 62 | a.db = db 63 | 64 | a.createTable() 65 | } 66 | 67 | func (a *Adapter) close() { 68 | a.db.Close() 69 | } 70 | 71 | func (a *Adapter) createTable() { 72 | _, err := a.db.Exec("CREATE table IF NOT EXISTS policy (ptype VARCHAR(10), v1 VARCHAR(256), v2 VARCHAR(256), v3 VARCHAR(256), v4 VARCHAR(256))") 73 | if err != nil { 74 | panic(err) 75 | } 76 | } 77 | 78 | func (a *Adapter) dropTable() { 79 | _, err := a.db.Exec("DROP table policy") 80 | if err != nil { 81 | panic(err) 82 | } 83 | } 84 | 85 | func loadPolicyLine(line string, model model.Model) { 86 | if line == "" { 87 | return 88 | } 89 | 90 | tokens := strings.Split(line, ", ") 91 | 92 | key := tokens[0] 93 | sec := key[:1] 94 | model[sec][key].Policy = append(model[sec][key].Policy, tokens[1:]) 95 | } 96 | 97 | // LoadPolicy loads policy from database. 98 | func (a *Adapter) LoadPolicy(model model.Model) error { 99 | a.open() 100 | defer a.close() 101 | 102 | var ( 103 | ptype string 104 | v1 string 105 | v2 string 106 | v3 string 107 | v4 string 108 | ) 109 | 110 | rows, err := a.db.Query("select * from policy") 111 | if err != nil { 112 | return err 113 | } 114 | defer rows.Close() 115 | for rows.Next() { 116 | err := rows.Scan(&ptype, &v1, &v2, &v3, &v4) 117 | if err != nil { 118 | return err 119 | } 120 | 121 | line := ptype 122 | if v1 != "" { 123 | line += ", " + v1 124 | } 125 | if v2 != "" { 126 | line += ", " + v2 127 | } 128 | if v3 != "" { 129 | line += ", " + v3 130 | } 131 | if v4 != "" { 132 | line += ", " + v4 133 | } 134 | 135 | loadPolicyLine(line, model) 136 | // log.Println(ptype, v1, v2, v3, v4) 137 | } 138 | err = rows.Err() 139 | return err 140 | } 141 | 142 | func (a *Adapter) writeTableLine(stm *sql.Stmt, ptype string, rule []string) error { 143 | params := make([]interface{}, 0, 5) 144 | params = append(params, ptype) 145 | for _, v := range rule { 146 | params = append(params, v) 147 | } 148 | need := 5 - len(params) 149 | for i := 0; i < need; i++ { 150 | params = append(params, "") 151 | } 152 | if _, err := stm.Exec(params...); err != nil { 153 | return err 154 | } 155 | return nil 156 | } 157 | 158 | // SavePolicy saves policy to database. 159 | func (a *Adapter) SavePolicy(model model.Model) error { 160 | a.open() 161 | defer a.close() 162 | 163 | a.dropTable() 164 | a.createTable() 165 | 166 | stm, err := a.db.Prepare("insert into policy values(?, ?, ?, ?, ?)") 167 | if err != nil { 168 | return err 169 | } 170 | defer stm.Close() 171 | 172 | for ptype, ast := range model["p"] { 173 | for _, rule := range ast.Policy { 174 | if err = a.writeTableLine(stm, ptype, rule); err != nil { 175 | return err 176 | } 177 | } 178 | } 179 | 180 | for ptype, ast := range model["g"] { 181 | for _, rule := range ast.Policy { 182 | if err = a.writeTableLine(stm, ptype, rule); err != nil { 183 | return err 184 | } 185 | } 186 | } 187 | return nil 188 | } 189 | 190 | func (a *Adapter) AddPolicy(sec string, ptype string, policy []string) error { 191 | return errors.New("not implemented") 192 | } 193 | 194 | func (a *Adapter) RemovePolicy(sec string, ptype string, policy []string) error { 195 | return errors.New("not implemented") 196 | } 197 | 198 | func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error { 199 | return errors.New("not implemented") 200 | } 201 | -------------------------------------------------------------------------------- /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 mysqladapter 16 | 17 | import ( 18 | "log" 19 | "testing" 20 | 21 | "github.com/casbin/casbin" 22 | "github.com/casbin/casbin/util" 23 | ) 24 | 25 | func testGetPolicy(t *testing.T, e *casbin.Enforcer, res [][]string) { 26 | myRes := e.GetPolicy() 27 | log.Print("Policy: ", myRes) 28 | 29 | if !util.Array2DEquals(res, myRes) { 30 | t.Error("Policy: ", myRes, ", supposed to be ", res) 31 | } 32 | } 33 | 34 | func TestAdapter(t *testing.T) { 35 | // Because the MySQL DB is empty at first, 36 | // so we need to load the policy from the file adapter (.CSV) first. 37 | e := casbin.NewEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv") 38 | 39 | a := NewAdapter("mysql", "root:@tcp(127.0.0.1:3306)/") 40 | // This is a trick to save the current policy to the MySQL DB. 41 | // We can't call e.SavePolicy() because the adapter in the enforcer is still the file adapter. 42 | // The current policy means the policy in the Casbin enforcer (aka in memory). 43 | a.SavePolicy(e.GetModel()) 44 | 45 | // Clear the current policy. 46 | e.ClearPolicy() 47 | testGetPolicy(t, e, [][]string{}) 48 | 49 | // Load the policy from MySQL DB. 50 | a.LoadPolicy(e.GetModel()) 51 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}}) 52 | 53 | // Note: you don't need to look at the above code 54 | // if you already have a working MySQL DB with policy inside. 55 | 56 | // Now the MySQL DB has policy, so we can provide a normal use case. 57 | // Create an adapter and an enforcer. 58 | // NewEnforcer() will load the policy automatically. 59 | a = NewAdapter("mysql", "root:@tcp(127.0.0.1:3306)/") 60 | e = casbin.NewEnforcer("examples/rbac_model.conf", a) 61 | testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"data2_admin", "data2", "read"}, {"data2_admin", "data2", "write"}}) 62 | } 63 | -------------------------------------------------------------------------------- /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 --------------------------------------------------------------------------------