├── .gitignore ├── README.md ├── src ├── lib.rs └── authz.rs ├── Cargo.toml ├── benches └── benchmarks.rs └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | Cargo.lock 2 | target/ 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rust-Authz 2 | 3 | This is an authorization library written in Rust that offers permission-based 4 | authorization based on an implementation in Yosai, and consequently Apache Shiro. 5 | 6 | 7 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #[macro_use] 2 | extern crate serde_derive; 3 | 4 | extern crate serde; 5 | extern crate serde_json; 6 | 7 | pub mod authz; 8 | pub use authz::{is_permitted_from_str, is_permitted_from_perm, perms_from_buffer, Permission}; 9 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "authz" 3 | description = "Permission-based authorization library" 4 | version = "0.1.5" 5 | authors = ["Darin Gordon "] 6 | license = "Apache-2.0" 7 | homepage = "https://github.com/Dowwie/rust-authz" 8 | readme = "README.md" 9 | 10 | 11 | [dependencies] 12 | serde = "^0.9.5" 13 | serde_derive = "^0.9.5" 14 | serde_json = "^0.9.4" 15 | 16 | 17 | [dev-dependencies] 18 | bencher = "0.1.2" 19 | 20 | 21 | [lib] 22 | crate-type = ["cdylib", "rlib"] 23 | -------------------------------------------------------------------------------- /benches/benchmarks.rs: -------------------------------------------------------------------------------- 1 | #![feature(test)] 2 | 3 | extern crate authz; 4 | extern crate serde_json; 5 | 6 | #[macro_use] 7 | extern crate bencher; 8 | 9 | extern crate test; 10 | use test::Bencher; 11 | 12 | fn test_permitted_from_string() { 13 | let required_perm = "domain1:action4:target4"; 14 | let assigned_perms: Vec<&str> = vec!("domain1:action1", "domain1:action2", "domain1:action4"); 15 | let _ = authz::is_permitted_from_str(&required_perm, assigned_perms); 16 | } 17 | 18 | fn test_permitted_from_json(required: &str, serialized: String) { 19 | let deserialized: Vec = authz::perms_from_buffer(serialized.as_bytes()).unwrap(); 20 | let _ = authz::is_permitted_from_perm(&required, deserialized); 21 | } 22 | 23 | #[bench] 24 | fn test_is_permitted_from_string(b: &mut Bencher) { 25 | b.iter(|| test_permitted_from_string()) 26 | } 27 | 28 | #[bench] 29 | fn test_is_permitted_from_json(b: &mut Bencher) { 30 | let required = "domain2:action4:target7"; 31 | let permissions: Vec = vec![authz::Permission::new("domain1:action1"), 32 | authz::Permission::new("domain2:action3,action4")]; 33 | b.iter(|| test_permitted_from_json(required, serde_json::to_string(&permissions).unwrap())) 34 | } 35 | -------------------------------------------------------------------------------- /src/authz.rs: -------------------------------------------------------------------------------- 1 | extern crate serde; 2 | extern crate serde_json; 3 | 4 | use std::str; 5 | use std::error::Error; 6 | use std::collections::HashSet; 7 | 8 | static PART_DELIMETER: &'static str = ":"; 9 | static SUBPART_DELIMETER: &'static str = ","; 10 | 11 | #[derive(Debug, PartialEq, Serialize, Deserialize)] 12 | pub struct Permission { 13 | 14 | #[serde(default = "default_part")] 15 | domain: String, 16 | 17 | #[serde(default = "default_hash_part")] 18 | actions: HashSet, 19 | 20 | #[serde(default = "default_hash_part")] 21 | targets: HashSet 22 | } 23 | 24 | fn default_part() -> String { 25 | "*".to_string() 26 | } 27 | 28 | fn default_hash_part() -> HashSet { 29 | ["*"].into_iter().map(|s| s.to_string()).collect() 30 | } 31 | 32 | impl<'a> Permission { 33 | pub fn new(wildcard_perm: &str) -> Permission { 34 | let (domain, actions, targets) = Permission::init_parts(wildcard_perm); 35 | let perm = Permission { 36 | domain: domain, 37 | actions: actions, 38 | targets: targets, 39 | }; 40 | perm 41 | } 42 | 43 | fn part_from_str(s: Option<&str>) -> HashSet { 44 | let mut set = HashSet::new(); 45 | match s { 46 | Some("") | None => { 47 | set.insert(String::from("*")); 48 | } 49 | Some(s) => { 50 | for rule in s.split(SUBPART_DELIMETER).map(str::trim) { 51 | set.insert(String::from(rule)); 52 | } 53 | } 54 | } 55 | set 56 | } 57 | 58 | fn init_parts(wildcard_perm: &str) -> (String, HashSet, HashSet) { 59 | let mut iter = wildcard_perm.split(PART_DELIMETER).map(str::trim); 60 | 61 | let domain = match iter.next() { 62 | Some("") | Some("*") | None => String::from("*"), 63 | Some(domain) => String::from(domain), 64 | }; 65 | let actions = Permission::part_from_str(iter.next()); 66 | let targets = Permission::part_from_str(iter.next()); 67 | 68 | (domain, actions, targets) 69 | } 70 | 71 | pub fn implies_from_str(&self, wildcard_permission: &str) -> bool { 72 | let permission = Permission::new(wildcard_permission); 73 | self.implies_from_perm(&permission) 74 | } 75 | 76 | pub fn implies_from_perm(&self, permission: &Permission) -> bool { 77 | if self.domain != "*" { 78 | if self.domain != permission.domain { 79 | return false; 80 | } 81 | } 82 | 83 | if !self.actions.contains("*") { 84 | if !&self.actions.is_superset(&permission.actions) { 85 | return false; 86 | } 87 | } 88 | 89 | if !self.targets.contains("*") { 90 | if !&self.targets.is_superset(&permission.targets) { 91 | return false; 92 | } 93 | } 94 | return true; 95 | } 96 | } 97 | 98 | pub fn is_permitted_from_str<'a, I>(required_perm: &str, assigned_perms: I) -> i32 99 | where I: IntoIterator 100 | { 101 | let required_permission = Permission::new(&required_perm); 102 | 103 | for assigned in assigned_perms { 104 | let assigned_permission = Permission::new(assigned); 105 | if assigned_permission.implies_from_perm(&required_permission) { 106 | return 1; 107 | } 108 | } 109 | return 0; 110 | } 111 | 112 | pub fn is_permitted_from_perm(required_perm: &str, assigned_perms: Vec) -> i32 { 113 | let required_permission = Permission::new(required_perm); 114 | 115 | for assigned in assigned_perms { 116 | if assigned.implies_from_perm(&required_permission) { 117 | return 1; 118 | } 119 | } 120 | return 0; 121 | } 122 | 123 | pub fn perms_from_buffer(serialized_perms: &[u8]) -> Result, Box> { 124 | let result = try!(serde_json::from_slice(serialized_perms)); 125 | Ok(result) 126 | } 127 | 128 | #[cfg(test)] 129 | mod test { 130 | extern crate serde_json; 131 | use authz::{Permission, is_permitted_from_str, is_permitted_from_perm, perms_from_buffer}; 132 | use std::collections::HashSet; 133 | 134 | #[test] 135 | fn test_new_permission() { 136 | 137 | struct Perm<'a> { 138 | wildcard_perm: &'a str, 139 | domain: &'a str, 140 | actions: Vec<&'a str>, 141 | targets: Vec<&'a str>, 142 | } 143 | 144 | let tests = [Perm { wildcard_perm: "", domain: "*", actions: vec!["*"], targets: vec!["*"],}, 145 | Perm { wildcard_perm: "domain1", domain: "domain1", actions: vec!["*"], targets: vec!["*"],}, 146 | Perm { wildcard_perm: "domain1:action1", domain: "domain1", actions: vec!["action1"], targets: vec!["*"], }, 147 | Perm { wildcard_perm: ":action1, action2, action3", domain: "*", actions: vec!["action1", "action2", "action3"], targets: vec!["*"],}, 148 | Perm { wildcard_perm: "domain1:action1, action2:target1, target2", domain: "domain1", actions: vec!["action1", "action2"], targets: vec!["target1", "target2"], }]; 149 | 150 | for test in tests.iter() { 151 | let perm: Permission = Permission::new(test.wildcard_perm); 152 | 153 | let expected_actions: HashSet = 154 | test.actions.iter().map(|x| x.to_string()).collect(); 155 | let expected_targets: HashSet = 156 | test.targets.iter().map(|x| x.to_string()).collect(); 157 | 158 | assert_eq!(perm.domain == test.domain, true); 159 | assert_eq!(perm.actions == expected_actions, true); 160 | assert_eq!(perm.targets == expected_targets, true); 161 | } 162 | } 163 | 164 | #[test] 165 | fn test_part_from_str() { 166 | let tests = vec![(Some(""), vec!["*"]), 167 | (None, vec!["*"]), 168 | (Some("action1, action2, action3"), vec!["action1", "action2", "action3"]), 169 | (Some("incorrect format"), vec!["incorrect format"])]; 170 | for &(ref input, ref expected) in tests.iter(){ 171 | let expected_result: HashSet = expected.iter().map(|x| x.to_string()).collect(); 172 | let result: HashSet = Permission::part_from_str(*input); 173 | assert_eq!(result, expected_result); 174 | } 175 | } 176 | 177 | #[test] 178 | fn test_implies_from_str() { 179 | let perm = Permission::new("domain1:action1"); 180 | assert_eq!(perm.implies_from_str("domain1:action1:target1"), true); 181 | assert_eq!(perm.implies_from_str("domain1:action2"), false); 182 | } 183 | 184 | #[test] 185 | fn test_implies_from_perm() { 186 | let perm1: Permission = Permission::new("domain1:action1"); 187 | let perm2: Permission = Permission::new("domain1:action1,action2"); 188 | let perm3: Permission = Permission::new("domain1:action1,action2:target1"); 189 | let perm4: Permission = Permission::new("domain1:action3,action4:target2,target3"); 190 | let perm5: Permission = Permission::new("domain1:action1,action2,action3,action4"); 191 | let perm6: Permission = Permission::new(":action1,action2,action3,action4"); 192 | let perm7: Permission = Permission::new("domain1:action1,action3:target1, target2"); 193 | let perm7b: Permission = Permission::new("domain1:action5"); 194 | let perm8: Permission = Permission::new(""); 195 | 196 | assert_eq!(perm5.implies_from_perm(&perm1), true); 197 | assert_eq!(perm5.implies_from_perm(&perm2), true); 198 | assert_eq!(perm5.implies_from_perm(&perm3), true); 199 | assert_eq!(perm5.implies_from_perm(&perm4), true); 200 | assert_eq!(perm1.implies_from_perm(&perm5), false); 201 | assert_eq!(perm3.implies_from_perm(&perm5), false); 202 | assert_eq!(perm6.implies_from_perm(&perm7), true); 203 | assert_eq!(perm7.implies_from_perm(&perm6), false); 204 | assert_eq!(perm6.implies_from_perm(&perm7b), false); 205 | assert_eq!(perm7b.implies_from_perm(&perm6), false); 206 | assert_eq!(perm8.implies_from_perm(&perm1), true); 207 | assert_eq!(perm1.implies_from_perm(&perm8), false); 208 | assert_eq!(perm8.implies_from_perm(&perm2), true); 209 | assert_eq!(perm2.implies_from_perm(&perm8), false); 210 | assert_eq!(perm8.implies_from_perm(&perm3), true); 211 | assert_eq!(perm3.implies_from_perm(&perm8), false); 212 | assert_eq!(perm8.implies_from_perm(&perm4), true); 213 | assert_eq!(perm4.implies_from_perm(&perm8), false); 214 | assert_eq!(perm8.implies_from_perm(&perm5), true); 215 | assert_eq!(perm5.implies_from_perm(&perm8), false); 216 | assert_eq!(perm8.implies_from_perm(&perm6), true); 217 | assert_eq!(perm6.implies_from_perm(&perm8), false); 218 | assert_eq!(perm8.implies_from_perm(&perm7), true); 219 | assert_eq!(perm7.implies_from_perm(&perm8), false); 220 | } 221 | 222 | #[test] 223 | fn test_internalis_permitted_from_str(){ 224 | let required: &str = "domain2:action4:target7"; 225 | let assigned: Vec<&str> = vec!["domain1:action1", "domain2:action3,action4"]; 226 | assert_eq!(is_permitted_from_str(required, assigned.into_iter()), 1); 227 | } 228 | 229 | #[test] 230 | fn test_is_permitted_from_perm() { 231 | let required: &str = "domain2:action4:target7"; 232 | let assigned: Vec = vec![Permission::new("domain1:action1"), 233 | Permission::new("domain2:action3,action4")]; 234 | assert_eq!(is_permitted_from_perm(required, assigned), 1); 235 | } 236 | 237 | #[test] 238 | fn test_perms_from_buffer() { 239 | let permissions: Vec = vec![Permission::new("domain1:action1"), 240 | Permission::new("domain2:action3,action4")]; 241 | let serialized = serde_json::to_string(&permissions).unwrap(); 242 | let result: Vec = perms_from_buffer(serialized.as_bytes()).unwrap(); 243 | assert_eq!(result, permissions); 244 | } 245 | } 246 | -------------------------------------------------------------------------------- /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 2017 Darin Gordon 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 | --------------------------------------------------------------------------------