forked from ppetermann/pheal
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added experimental version of an access check module by providing key…
…Type + accessMask when creating a Pheal Object. Pheal will throw an PhealAccessException when a access violations has been detected. No api call will be made to avoid doing non-permitted calls to ccp's api server
- Loading branch information
Showing
7 changed files
with
346 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <?php | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2010 Peter Petermann | ||
| Permission is hereby granted, free of charge, to any person | ||
| obtaining a copy of this software and associated documentation | ||
| files (the "Software"), to deal in the Software without | ||
| restriction, including without limitation the rights to use, | ||
| copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the | ||
| Software is furnished to do so, subject to the following | ||
| conditions: | ||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
| OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | ||
| HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
| OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
| /** | ||
| * Pheal Access Exception. Should be thrown when Pheal dedects a not allowed API Call based on accessMask | ||
| */ | ||
| class PhealAccessException extends PhealException | ||
| { | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?php | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2010 Peter Petermann | ||
| Permission is hereby granted, free of charge, to any person | ||
| obtaining a copy of this software and associated documentation | ||
| files (the "Software"), to deal in the Software without | ||
| restriction, including without limitation the rights to use, | ||
| copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the | ||
| Software is furnished to do so, subject to the following | ||
| conditions: | ||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
| OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | ||
| HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
| OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
| /** | ||
| * Interface that should be implemented by the access handlers | ||
| */ | ||
| interface PhealAccessInterface | ||
| { | ||
| /** | ||
| * Check if the api key is allowed to make this api call | ||
| * @param string $scope | ||
| * @param string $name | ||
| * @param string $type | ||
| * @param int $accessMask | ||
| */ | ||
| public function check($scope, $name, $type, $accessMask); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| <?php | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2010 Peter Petermann, Daniel Hoffend | ||
| Permission is hereby granted, free of charge, to any person | ||
| obtaining a copy of this software and associated documentation | ||
| files (the "Software"), to deal in the Software without | ||
| restriction, including without limitation the rights to use, | ||
| copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the | ||
| Software is furnished to do so, subject to the following | ||
| conditions: | ||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
| OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | ||
| HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
| OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
|
|
||
| /** | ||
| * check access modules. Check if the given keyinfo allows a specific api call | ||
| * access bits are static for performance reason. Feel free to write your own version | ||
| * if you like to check api->calllist live. | ||
| * | ||
| * new/unknown api calls are allowed by default. | ||
| */ | ||
| class PhealCheckAccess implements PhealAccessInterface | ||
| { | ||
| /** | ||
| * Database of calls to check against the given keyinfo | ||
| * list based on pheal()->apiScope->calllist() | ||
| * with manually added information | ||
| * @var array | ||
| */ | ||
| protected $bits = array( | ||
| 'char' => array( | ||
| 'contracts' => array('Character', 67108864), | ||
| 'wallettransactions' => array('Character', 4194304), | ||
| 'walletjournal' => array('Character', 2097152), | ||
| 'upcomingcalendarevents' => array('Character', 1048576), | ||
| 'standings' => array('Character', 524288), | ||
| 'skillqueue' => array('Character', 262144), | ||
| 'skillintraining' => array('Character', 131072), | ||
| 'research' => array('Character', 65536), | ||
| 'notificationtexts' => array('Character', 32768), | ||
| 'notifications' => array('Character', 16384), | ||
| 'medals' => array('Character', 8192), | ||
| 'marketorders' => array('Character', 4096), | ||
| 'mailmessages' => array('Character', 2048), | ||
| 'mailinglists' => array('Character', 1024), | ||
| 'mailbodies' => array('Character', 512), | ||
| 'killlog' => array('Character', 256), | ||
| 'industryjobs' => array('Character', 128), | ||
| 'facwarstats' => array('Character', 64), | ||
| 'contactnotifications' => array('Character', 32), | ||
| 'contactlist' => array('Character', 16), | ||
| 'charactersheet' => array('Character', 8), | ||
| 'calendareventattendees' => array('Character', 4), | ||
| 'assetlist' => array('Character', 2), | ||
| 'accountbalance' => array('Character', 1) | ||
| ), | ||
| 'account' => array( | ||
| 'accountstatus' => array('Character', 33554432) | ||
| ), | ||
| 'corp' => array( | ||
| 'contracts' => array('Corporation', 8388608), | ||
| 'titles' => array('Corporation', 4194304), | ||
| 'wallettransactions' => array('Corporation', 2097152), | ||
| 'walletjournal' => array('Corporation', 1048576), | ||
| 'starbaselist' => array('Corporation', 524288), | ||
| 'standings' => array('Corporation', 262144), | ||
| 'starbasedetail' => array('Corporation', 131072), | ||
| 'shareholders' => array('Corporation', 65536), | ||
| 'outpostservicedetail' => array('Corporation', 32768), | ||
| 'outpostlist' => array('Corporation', 16384), | ||
| 'medals' => array('Corporation', 8192), | ||
| 'marketorders' => array('Corporation', 4096), | ||
| 'membertracking' => array('Corporation', 2048), | ||
| 'membersecuritylog' => array('Corporation', 1024), | ||
| 'membersecurity' => array('Corporation', 512), | ||
| 'killlog' => array('Corporation', 256), | ||
| 'industryjobs' => array('Corporation', 128), | ||
| 'facwarstats' => array('Corporation', 64), | ||
| 'containerlog' => array('Corporation', 32), | ||
| 'contactlist' => array('Corporation', 16), | ||
| 'corporationsheet' => array('Corporation', 8), | ||
| 'membermedals' => array('Corporation', 4), | ||
| 'assetlist' => array('Corporation', 2), | ||
| 'accountbalance' => array('Corporation', 1) | ||
| ) | ||
|
|
||
| // characterinfo is a public call with more details if you've better api keys | ||
| // no detailed configuration needed atm | ||
| /* | ||
| 'eve' => array( | ||
| 'characterinfo' => array('Character', array(16777216, 8388608)) | ||
| ) | ||
| */ | ||
|
|
||
| ); | ||
|
|
||
| /** | ||
| * Check if the api key is allowed to make this api call | ||
| * @param string $scope | ||
| * @param string $name | ||
| * @param string $type | ||
| * @param int $accessMask | ||
| */ | ||
| public function check($scope, $name, $type, $accessMask) | ||
| { | ||
| // there's no "Account" type on the access bits level | ||
| $keytype = ($type == "Account") ? "Character" : $type; | ||
|
|
||
| // no keyinfo or access bit configuration found | ||
| // assume it's a public call or it's not yet defined | ||
| // allow and let the CCP decide | ||
| if( !$type | ||
| || !$accessMask | ||
| || !in_array($keytype, array('Character','Corporation')) | ||
| || !isset($this->bits[strtolower($scope)][strtolower($name)])) | ||
| return true; | ||
|
|
||
| // check accessLevel | ||
| $check = $this->bits[strtolower($scope)][strtolower($name)]; | ||
|
|
||
| // check if keytype is correct for this call | ||
| if($check[0] == $keytype) { | ||
|
|
||
| // check single accessbit | ||
| if(is_int($check[1]) && $check[1] & $accessMask) | ||
| return true; | ||
|
|
||
| // fix if multiple accessbits are valid (eve/CharacterInfo) | ||
| //elseif(is_array($check[1])) | ||
| // foreach($check[1] AS $checkbit) | ||
| // if($checkbit && $checkbit & $accessMask) | ||
| // return true; | ||
| } | ||
|
|
||
| // no match == no access right found. | ||
| throw new PhealAccessException(sprintf( | ||
| "Pheal blocked an API call (%s/%s) which is not allowed by the given keyType/accessMask (%s/%d)", | ||
| $scope, | ||
| $name, | ||
| $type, | ||
| $accessMask | ||
| )); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
| /* | ||
| MIT License | ||
| Copyright (c) 2010 Peter Petermann, Daniel Hoffend | ||
| Permission is hereby granted, free of charge, to any person | ||
| obtaining a copy of this software and associated documentation | ||
| files (the "Software"), to deal in the Software without | ||
| restriction, including without limitation the rights to use, | ||
| copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the | ||
| Software is furnished to do so, subject to the following | ||
| conditions: | ||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
| OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | ||
| HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
| OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
|
|
||
| /** | ||
| * null access, as a placeholder if no access verification is used | ||
| */ | ||
| class PhealNullAccess implements PhealAccessInterface | ||
| { | ||
| /** | ||
| * Check if the api key is allowed to make this api call | ||
| * @param string $scope | ||
| * @param string $name | ||
| * @param string $type | ||
| * @param int $accessMask | ||
| */ | ||
| public function check($scope, $name, $type, $accessMask) | ||
| { | ||
| return true; | ||
| } | ||
| } |
Oops, something went wrong.