diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..55940e5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/vendor/ +composer.lock \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index dafb637..8b8df83 100644 --- a/README.md +++ b/README.md @@ -1 +1,65 @@ -# policy \ No newline at end of file +# EasySwoole Policy +用于验证、解析Policy结构和语法 +## 安装 +```bash +composer require EasySwoole/Policy +``` +## 使用方法 +```php + +$policyData = [ + "Statement" => [ + [ + "Effect" => "Allow", + "Action" => ["goods/*", "goods/list"], + ], + [ + "Effect" => "Allow", + "Action" => ["goods/*", "goods/list"], + ], + [ + "Effect" => "Allow", + "Action" => ["goods/*", "goods/list"], + ], + ], +]; +$policy = new \EasySwoole\Policy\Policy(); +$policy->addPolicy( new \EasySwoole\Policy\RequestBean\Policy( $policyData ) ); +// 可以添加多组,目的:一个用户属于多个角色组的时候,或者一个角色组对应多个存储的policy的时候 +$policy->addPolicy( new \EasySwoole\Policy\RequestBean\Policy( $policyData ) ); +$result = $policy->verify( 'goods/list' ); +var_dump( $result ); +``` + + +策略json格式如下: +```json +{ + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "goods/*", + "goods/list" + ] + }, + { + "Effect": "Allow", + "Action": [ + "goods/*", + "goods/list" + ] + }, + { + "Effect": "Allow", + "Action": [ + "goods/*", + "goods/list" + ] + } + ] +} + +``` + +- 前端policy验证的库 https://github.com/hanwenbo/policy.js diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..de7b0ae --- /dev/null +++ b/composer.json @@ -0,0 +1,19 @@ +{ + "name": "EasySwoole/Policy", + "authors": [ + { + "name": "韩文博", + "email": "9476400@qq.com" + } + ], + "autoload": { + "psr-4": { + "EasySwoole\\Policy\\": "src/" + } + }, + "require": { + "php": "^7.2", + "easyswoole/spl": "^1.1", + "ext-json":">=1.0" + } +} diff --git a/src/Policy.php b/src/Policy.php new file mode 100644 index 0000000..dd6b676 --- /dev/null +++ b/src/Policy.php @@ -0,0 +1,167 @@ +preParse(); + + list( $controller ) = explode( '/', $actionName ); + $allow = in_array( $actionName, $this->allowActions ) || in_array( "{$controller}/*", $this->allowActions ) || in_array( '*', $this->allowActions ); + + $deny = in_array( $actionName, $this->denyActions ) || in_array( "{$controller}/*", $this->denyActions ) || in_array( '*', $this->denyActions ); + + return $allow && !$deny; + } + + /** + * @param array | string $actions + */ + public function setAllowActions( array $actions ) : void + { + $this->allowActions = $actions; + } + + /** + * @param array $actions + */ + public function setDenyActions( array $actions ) : void + { + $this->denyActions = $actions; + } + + public function addPolicy( PolicyRequest $policy ) + { + array_push( $this->policyList, $policy ); + } + + /** + * 预解析 + */ + protected function preParse() : void + { + foreach( $this->policyList as $policy ){ + if( $policy instanceof PolicyRequest ){ + $statement_list = $policy->getStatement(); + foreach($statement_list as $statement_item){ + $statement = new Statement( $statement_item ); + if( $statement->getEffect() === 'Allow' ){ + $this->allowActions = array_unique( array_merge( $this->allowActions, $statement->getAction() ) ); + } else if( $statement->getEffect() === 'Deny' ){ + $this->denyActions = array_unique( array_merge( $this->denyActions, $statement->getAction() ) ); + } + } + } + } + } + + /** + * @return array + */ + public function getPolicyList() : array + { + return $this->policyList; + } + + /** + * @param array $policyList + */ + public function setPolicyList( array $policyList ) : void + { + $this->policyList = $policyList; + } + + /** + * 验证数据结构 + * 用于添加或者修改的时候判断是否符合本库数据结构的要求 + * @param array $structure + * @return bool + */ + public function verifyStructure(array $structure) : bool { + if(isset($structure['Statement']) && is_array($structure['Statement'])){ + $this->setErrMsg('Statement must be set or is array'); + foreach($structure['Statement'] as $statement){ + if(!isset($statement['Effect']) || !in_array($statement['Effect'],['Allow','Deny'])){ + $this->setErrMsg('Effect must be in Allow|Deny'); + return false; + } + if(!isset($statement['Action']) || !is_array($statement['Action']) || empty($statement['Action'])){ + $this->setErrMsg('Action must be set or array`s length > 0'); + return false; + }else{ + // 不允许重复 + if (count($statement['Action']) != count(array_unique($statement['Action']))) { + $this->setErrMsg('Action must be unique'); + return false; + } + // 语法要符合 * 或者 是 xx/xx + foreach($statement['Action'] as $action){ + if($action !== '*' && count(explode('/',$action)) !== 2){ + $this->setErrMsg('Action must be `*` or `controller/action` or `controller/*`'); + return false; + } + } + } + } + return true; + }else{ + return false; + } + } + + /** + * @return string + */ + public function getErrMsg() : string + { + return $this->errMsg; + } + + /** + * @param string $errMsg + */ + public function setErrMsg( string $errMsg ) : void + { + $this->errMsg = $errMsg; + } + +} + diff --git a/src/RequestBean/Policy.php b/src/RequestBean/Policy.php new file mode 100644 index 0000000..636d2bb --- /dev/null +++ b/src/RequestBean/Policy.php @@ -0,0 +1,41 @@ +Statement; + } + + /** + * @param array $Statement + */ + public function setStatement( array $Statement ) : void + { + $this->Statement = $Statement; + } + +} \ No newline at end of file diff --git a/src/RequestBean/Statement.php b/src/RequestBean/Statement.php new file mode 100644 index 0000000..b4118f9 --- /dev/null +++ b/src/RequestBean/Statement.php @@ -0,0 +1,60 @@ +Effect; + } + + /** + * @param string $Effect + */ + public function setEffect( string $Effect ) : void + { + $this->Effect = $Effect; + } + + /** + * @return array + */ + public function getAction() : array + { + return $this->Action; + } + + /** + * @param array $Action + */ + public function setAction( array $Action ) : void + { + $this->Action = $Action; + } + + +} \ No newline at end of file diff --git a/tests/test.json b/tests/test.json new file mode 100644 index 0000000..08253ba --- /dev/null +++ b/tests/test.json @@ -0,0 +1,25 @@ +{ + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "goods/*", + "goods/list" + ] + }, + { + "Effect": "Allow", + "Action": [ + "goods/*", + "goods/list" + ] + }, + { + "Effect": "Allow", + "Action": [ + "goods/*", + "goods/list" + ] + } + ] +} diff --git a/tests/test.php b/tests/test.php new file mode 100644 index 0000000..b9abb63 --- /dev/null +++ b/tests/test.php @@ -0,0 +1,25 @@ + [ + [ + "Effect" => "Allow", + "Action" => ["goods/*", "goods/list"], + ], + [ + "Effect" => "Allow", + "Action" => ["goods/*", "goods/list"], + ], + [ + "Effect" => "Allow", + "Action" => ["goods/*", "goods/list"], + ], + ], +]; +$policy = new \EasySwoole\Policy\Policy(); +$policy->addPolicy( new \EasySwoole\Policy\RequestBean\Policy( $policyData ) ); +// 可以添加多组,目的:一个用户属于多个角色组的时候,或者一个角色组对应多个存储的policy的时候 +$policy->addPolicy( new \EasySwoole\Policy\RequestBean\Policy( $policyData ) ); +$result = $policy->verify( 'goods/list' ); +var_dump( $result ); \ No newline at end of file