diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..3819f5c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +tests/ export-ignore +phpunit.xml export-ignore +build.xml export-ignore +test export-ignore +.travis.yml export-ignore \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..941a7dc --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +/vendor +/composer.lock +/build +/docs +/testing +/examples/relational/vendor +/examples/relational/config/oauth2.sqlite3 +/examples/nosql/vendor +/examples/nosql/config/oauth2.sqlite3 +/examples/relational/composer.lock +/tests/codecept/tests/_log +oauth2-server.paw +/output_*/ +/_site +.idea \ No newline at end of file diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 0000000..c5beb3f --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,36 @@ +filter: + excluded_paths: + - tests/* + - vendor/* + - examples/* +checks: + php: + code_rating: true + remove_extra_empty_lines: true + remove_php_closing_tag: true + remove_trailing_whitespace: true + fix_use_statements: + remove_unused: true + preserve_multiple: false + preserve_blanklines: true + order_alphabetically: true + fix_php_opening_tag: true + fix_linefeed: true + fix_line_ending: true + fix_identation_4spaces: true + fix_doc_comments: true +tools: + external_code_coverage: + timeout: 1800 + php_code_coverage: false + php_code_sniffer: + config: + standard: PSR2 + filter: + paths: ['src'] + php_loc: + enabled: true + excluded_dirs: [vendor, tests, examples] + php_cpd: + enabled: true + excluded_dirs: [vendor, tests, examples] diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ab0a406 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,205 @@ +# Changelog + +## 4.1.6 (released 2016-09-13) + +* Less restrictive on Authorization header check (Issue #652) + +## 4.1.5 (released 2016-01-04) + +* Enable Symfony 3.0 support (#412) + +## 4.1.4 (released 2015-11-13) + +* Fix for determining access token in header (Issue #328) +* Refresh tokens are now returned for MAC responses (Issue #356) +* Added integration list to readme (Issue #341) +* Expose parameter passed to exceptions (Issue #345) +* Removed duplicate routing setup code (Issue #346) +* Docs fix (Issues #347, #360, #380) +* Examples fix (Issues #348, #358) +* Fix typo in docblock (Issue #352) +* Improved timeouts for MAC tokens (Issue #364) +* `hash_hmac()` should output raw binary data, not hexits (Issue #370) +* Improved regex for matching all Base64 characters (Issue #371) +* Fix incorrect signature parameter (Issue #372) +* AuthCodeGrant and RefreshTokenGrant don't require client_secret (Issue #377) +* Added priority argument to event listener (Issue #388) + +## 4.1.3 (released 2015-03-22) + +* Docblock, namespace and inconsistency fixes (Issue #303) +* Docblock type fix (Issue #310) +* Example bug fix (Issue #300) +* Updated league/event to ~2.1 (Issue #311) +* Fixed missing session scope (Issue #319) +* Updated interface docs (Issue #323) +* `.travis.yml` updates + +## 4.1.2 (released 2015-01-01) + +* Remove side-effects in hash_equals() implementation (Issue #290) + +## 4.1.1 (released 2014-12-31) + +* Changed `symfony/http-foundation` dependency version to `~2.4` so package can be installed in Laravel `4.1.*` + +## 4.1.0 (released 2014-12-27) + +* Added MAC token support (Issue #158) +* Fixed example init code (Issue #280) +* Toggle refresh token rotation (Issue #286) +* Docblock fixes + +## 4.0.5 (released 2014-12-15) + +* Prevent duplicate session in auth code grant (Issue #282) + +## 4.0.4 (released 2014-12-03) + +* Ensure refresh token hasn't expired (Issue #270) + +## 4.0.3 (released 2014-12-02) + +* Fix bad type hintings (Issue #267) +* Do not forget to set the expire time (Issue #268) + +## 4.0.2 (released 2014-11-21) + +* Improved interfaces (Issue #255) +* Learnt how to spell delimiter and so `getScopeDelimiter()` and `setScopeDelimiter()` methods have been renamed +* Docblock improvements (Issue #254) + +## 4.0.1 (released 2014-11-09) + +* Alias the master branch in composer.json (Issue #243) +* Numerous PHP CodeSniffer fixes (Issue #244) +* .travis.yml update (Issue #245) +* The getAccessToken method should return an AccessTokenEntity object instead of a string in ResourceServer.php (#246) + +## 4.0.0 (released 2014-11-08) + +* Complete rewrite +* Check out the documentation - [http://oauth2.thephpleague.com](http://oauth2.thephpleague.com) + +## 3.2.0 (released 2014-04-16) + +* Added the ability to change the algorithm that is used to generate the token strings (Issue #151) + +## 3.1.2 (released 2014-02-26) + +* Support Authorization being an environment variable. [See more](http://fortrabbit.com/docs/essentials/quirks-and-constraints#authorization-header) + +## 3.1.1 (released 2013-12-05) + +* Normalize headers when `getallheaders()` is available (Issues #108 and #114) + +## 3.1.0 (released 2013-12-05) + +* No longer necessary to inject the authorisation server into a grant, the server will inject itself +* Added test for 1419ba8cdcf18dd034c8db9f7de86a2594b68605 + +## 3.0.1 (released 2013-12-02) + +* Forgot to tell TravisCI from testing PHP 5.3 + +## 3.0.0 (released 2013-12-02) + +* Fixed spelling of Implicit grant class (Issue #84) +* Travis CI now tests for PHP 5.5 +* Fixes for checking headers for resource server (Issues #79 and #) +* The word "bearer" now has a capital "B" in JSON output to match OAuth 2.0 spec +* All grants no longer remove old sessions by default +* All grants now support custom access token TTL (Issue #92) +* All methods which didn't before return a value now return `$this` to support method chaining +* Removed the build in DB providers - these will be put in their own repos to remove baggage in the main repository +* Removed support for PHP 5.3 because this library now uses traits and will use other modern PHP features going forward +* Moved some grant related functions into a trait to reduce duplicate code + +## 2.1.1 (released 2013-06-02) + +* Added conditional `isValid()` flag to check for Authorization header only (thanks @alexmcroberts) +* Fixed semantic meaning of `requireScopeParam()` and `requireStateParam()` by changing their default value to true +* Updated some duff docblocks +* Corrected array key call in Resource.php (Issue #63) + +## 2.1 (released 2013-05-10) + +* Moved zetacomponents/database to "suggest" in composer.json. If you rely on this feature you now need to include " zetacomponents/database" into "require" key in your own composer.json. (Issue #51) +* New method in Refresh grant called `rotateRefreshTokens()`. Pass in `true` to issue a new refresh token each time an access token is refreshed. This parameter needs to be set to true in order to request reduced scopes with the new access token. (Issue #47) +* Rename `key` column in oauth_scopes table to `scope` as `key` is a reserved SQL word. (Issue #45) +* The `scope` parameter is no longer required by default as per the RFC. (Issue #43) +* You can now set multiple default scopes by passing an array into `setDefaultScope()`. (Issue #42) +* The password and client credentials grants now allow for multiple sessions per user. (Issue #32) +* Scopes associated to authorization codes are not held in their own table (Issue #44) +* Database schema updates. + +## 2.0.5 (released 2013-05-09) + +* Fixed `oauth_session_token_scopes` table primary key +* Removed `DEFAULT ''` that has slipped into some tables +* Fixed docblock for `SessionInterface::associateRefreshToken()` + +## 2.0.4 (released 2013-05-09) + +* Renamed primary key in oauth_client_endpoints table +* Adding missing column to oauth_session_authcodes +* SECURITY FIX: A refresh token should be bound to a client ID + +## 2.0.3 (released 2013-05-08) + +* Fixed a link to code in composer.json + +## 2.0.2 (released 2013-05-08) + +* Updated README with wiki guides +* Removed `null` as default parameters in some methods in the storage interfaces +* Fixed license copyright + +## 2.0.0 (released 2013-05-08) + +**If you're upgrading from v1.0.8 there are lots of breaking changes** + +* Rewrote the session storage interface from scratch so methods are more obvious +* Included a PDO driver which implements the storage interfaces so the library is more "get up and go" +* Further normalised the database structure so all sessions no longer contain infomation related to authorization grant (which may or may not be enabled) +* A session can have multiple associated access tokens +* Induvidual grants can have custom expire times for access tokens +* Authorization codes now have a TTL of 10 minutes by default (can be manually set) +* Refresh tokens now have a TTL of one week by default (can be manually set) +* The client credentials grant will no longer gives out refresh tokens as per the specification + +## 1.0.8 (released 2013-03-18) + +* Fixed check for required state parameter +* Fixed check that user's credentials are correct in Password grant + +## 1.0.7 (released 2013-03-04) + +* Added method `requireStateParam()` +* Added method `requireScopeParam()` + +## 1.0.6 (released 2013-02-22) + +* Added links to tutorials in the README +* Added missing `state` parameter request to the `checkAuthoriseParams()` method. + +## 1.0.5 (released 2013-02-21) + +* Fixed the SQL example for SessionInterface::getScopes() + +## 1.0.3 (released 2013-02-20) + +* Changed all instances of the "authentication server" to "authorization server" + +## 1.0.2 (released 2013-02-20) + +* Fixed MySQL create table order +* Fixed version number in composer.json + +## 1.0.1 (released 2013-02-19) + +* Updated AuthServer.php to use `self::getParam()` + +## 1.0.0 (released 2013-02-15) + +* First major release \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0391ae5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +Thanks for contributing to this project. + + +**Please submit your pull request against the `develop` branch only.** + + +Please ensure that you run `phpunit` from the project root after you've made any changes. + +If you've added something new please create a new unit test, if you've changed something please update any unit tests as appropritate. + +We're trying to ensure there is **100%** test code coverage (including testing PHP errors and exceptions) so please ensure any new/updated tests cover all of your changes. + +Thank you, + +@alexbilbie diff --git a/README.md b/README.md new file mode 100644 index 0000000..e153dcd --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +# PHP OAuth 2.0 Server by [@alexbilbie](https://twitter.com/alexbilbie) + +[![Latest Version](http://img.shields.io/packagist/v/league/oauth2-server.svg?style=flat-square)](https://github.com/thephpleague/oauth2-server/releases) +[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) +[![Build Status](https://img.shields.io/travis/thephpleague/oauth2-server/master.svg?style=flat-square)](https://travis-ci.org/thephpleague/oauth2-server) +[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/oauth2-server.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/oauth2-server/code-structure) +[![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/oauth2-server.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/oauth2-server) +[![Total Downloads](https://img.shields.io/packagist/dt/league/oauth2-server.svg?style=flat-square)](https://packagist.org/packages/league/oauth2-server) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/thephpleague/oauth2-server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + + +A standards compliant [OAuth 2.0](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authorization server and resource server written in PHP which makes working with OAuth 2.0 trivial. You can easily configure an OAuth 2.0 server to protect your API with access tokens, or allow clients to request new access tokens and refresh them. + +It supports out of the box the following grants: + +* Authorization code grant +* Client credentials grant +* Resource owner password credentials grant +* Refresh grant + +You can also define your own grants. + +In addition it supports the following token types: + +* Bearer tokens +* MAC tokens +* JSON web tokens (coming soon) + +You can also create you own tokens. + + +## Requirements + +The following versions of PHP are supported: + +* PHP 5.4 +* PHP 5.5 +* PHP 5.6 +* HHVM + +## Documentation + +This library has [full documentation](http://oauth2.thephpleague.com), powered by [Jekyll](http://jekyllrb.com/). + +Contribute to this documentation in the [gh-pages branch](https://github.com/thephpleague/oauth2-server/tree/gh-pages/). + +## Changelog + +[See the project releases page](https://github.com/thephpleague/oauth2-server/releases) + +## Contributing + +Please see [CONTRIBUTING](https://github.com/thephpleague/oauth2-server/blob/master/CONTRIBUTING.md) for details. + +## Integration + +- [CakePHP 3](https://github.com/uafrica/oauth-server) +- [Laravel](https://github.com/lucadegasperi/oauth2-server-laravel) + +## Support + +Bugs and feature request are tracked on [GitHub](https://github.com/thephpleague/oauth2-server/issues) + +## Security + +If you discover any security related issues, please email hello@alexbilbie.com instead of using the issue tracker. + +## License + +This package is released under the MIT License. See the bundled [LICENSE](https://github.com/thephpleague/oauth2-server/blob/master/LICENSE) file for details. + +## Credits + +This code is principally developed and maintained by [Alex Bilbie](https://twitter.com/alexbilbie). + +Special thanks to: + +* [Dan Horrigan](https://github.com/dandoescode) +* [Nick Jackson](https://github.com/jacksonj04) +* [Michael Gooden](https://github.com/MichaelGooden) +* [Phil Sturgeon](https://github.com/philsturgeon) +* [and all the other contributors](https://github.com/thephpleague/oauth2-server/contributors) + +The initial code was developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which was funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme. diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..62a01ec --- /dev/null +++ b/composer.json @@ -0,0 +1,59 @@ +{ + "name": "league/oauth2-server", + "description": "A lightweight and powerful OAuth 2.0 authorization and resource server library with support for all the core specification grants. This library will allow you to secure your API with OAuth and allow your applications users to approve apps that want to access their data from your API.", + "homepage": "http://oauth2.thephpleague.com/", + "license": "MIT", + "require": { + "php": ">=5.4.0", + "symfony/http-foundation": "~2.4|~3.0", + "league/event": "~2.1" + }, + "require-dev": { + "phpunit/phpunit": "4.3.*", + "mockery/mockery": "0.9.*" + }, + "repositories": [ + { + "type": "git", + "url": "https://github.com/thephpleague/oauth2-server.git" + } + ], + "keywords": [ + "oauth", + "oauth2", + "oauth 2", + "oauth 2.0", + "server", + "auth", + "authorization", + "authorisation", + "authentication", + "resource", + "api", + "auth", + "protect", + "secure" + ], + "authors": [ + { + "name": "Alex Bilbie", + "email": "hello@alexbilbie.com", + "homepage": "http://www.alexbilbie.com", + "role": "Developer" + } + ], + "replace": { + "lncd/oauth2": "*", + "league/oauth2server": "*" + }, + "autoload": { + "psr-4": { + "League\\OAuth2\\Server\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "LeagueTests\\": "tests/unit/" + } + } +} diff --git a/examples/relational/Model/Users.php b/examples/relational/Model/Users.php new file mode 100644 index 0000000..76caab8 --- /dev/null +++ b/examples/relational/Model/Users.php @@ -0,0 +1,25 @@ +select(['username', 'password', 'name', 'email', 'photo']); + + if ($username !== null) { + $query->where('username', '=', $username); + } + + $result = $query->get(); + + if (count($result) > 0) { + return $result; + } + + return; + } +} diff --git a/examples/relational/Storage/AccessTokenStorage.php b/examples/relational/Storage/AccessTokenStorage.php new file mode 100644 index 0000000..bd1a5ca --- /dev/null +++ b/examples/relational/Storage/AccessTokenStorage.php @@ -0,0 +1,93 @@ +where('access_token', $token) + ->get(); + + if (count($result) === 1) { + $token = (new AccessTokenEntity($this->server)) + ->setId($result[0]['access_token']) + ->setExpireTime($result[0]['expire_time']); + + return $token; + } + + return; + } + + /** + * {@inheritdoc} + */ + public function getScopes(AccessTokenEntity $token) + { + $result = Capsule::table('oauth_access_token_scopes') + ->select(['oauth_scopes.id', 'oauth_scopes.description']) + ->join('oauth_scopes', 'oauth_access_token_scopes.scope', '=', 'oauth_scopes.id') + ->where('access_token', $token->getId()) + ->get(); + + $response = []; + + if (count($result) > 0) { + foreach ($result as $row) { + $scope = (new ScopeEntity($this->server))->hydrate([ + 'id' => $row['id'], + 'description' => $row['description'], + ]); + $response[] = $scope; + } + } + + return $response; + } + + /** + * {@inheritdoc} + */ + public function create($token, $expireTime, $sessionId) + { + Capsule::table('oauth_access_tokens') + ->insert([ + 'access_token' => $token, + 'session_id' => $sessionId, + 'expire_time' => $expireTime, + ]); + } + + /** + * {@inheritdoc} + */ + public function associateScope(AccessTokenEntity $token, ScopeEntity $scope) + { + Capsule::table('oauth_access_token_scopes') + ->insert([ + 'access_token' => $token->getId(), + 'scope' => $scope->getId(), + ]); + } + + /** + * {@inheritdoc} + */ + public function delete(AccessTokenEntity $token) + { + Capsule::table('oauth_access_tokens') + ->where('access_token', $token->getId()) + ->delete(); + } +} diff --git a/examples/relational/Storage/AuthCodeStorage.php b/examples/relational/Storage/AuthCodeStorage.php new file mode 100644 index 0000000..c0f84d9 --- /dev/null +++ b/examples/relational/Storage/AuthCodeStorage.php @@ -0,0 +1,93 @@ +where('auth_code', $code) + ->where('expire_time', '>=', time()) + ->get(); + + if (count($result) === 1) { + $token = new AuthCodeEntity($this->server); + $token->setId($result[0]['auth_code']); + $token->setRedirectUri($result[0]['client_redirect_uri']); + $token->setExpireTime($result[0]['expire_time']); + + return $token; + } + + return; + } + + public function create($token, $expireTime, $sessionId, $redirectUri) + { + Capsule::table('oauth_auth_codes') + ->insert([ + 'auth_code' => $token, + 'client_redirect_uri' => $redirectUri, + 'session_id' => $sessionId, + 'expire_time' => $expireTime, + ]); + } + + /** + * {@inheritdoc} + */ + public function getScopes(AuthCodeEntity $token) + { + $result = Capsule::table('oauth_auth_code_scopes') + ->select(['oauth_scopes.id', 'oauth_scopes.description']) + ->join('oauth_scopes', 'oauth_auth_code_scopes.scope', '=', 'oauth_scopes.id') + ->where('auth_code', $token->getId()) + ->get(); + + $response = []; + + if (count($result) > 0) { + foreach ($result as $row) { + $scope = (new ScopeEntity($this->server))->hydrate([ + 'id' => $row['id'], + 'description' => $row['description'], + ]); + $response[] = $scope; + } + } + + return $response; + } + + /** + * {@inheritdoc} + */ + public function associateScope(AuthCodeEntity $token, ScopeEntity $scope) + { + Capsule::table('oauth_auth_code_scopes') + ->insert([ + 'auth_code' => $token->getId(), + 'scope' => $scope->getId(), + ]); + } + + /** + * {@inheritdoc} + */ + public function delete(AuthCodeEntity $token) + { + Capsule::table('oauth_auth_codes') + ->where('auth_code', $token->getId()) + ->delete(); + } +} diff --git a/examples/relational/Storage/ClientStorage.php b/examples/relational/Storage/ClientStorage.php new file mode 100644 index 0000000..9d62263 --- /dev/null +++ b/examples/relational/Storage/ClientStorage.php @@ -0,0 +1,70 @@ +select('oauth_clients.*') + ->where('oauth_clients.id', $clientId); + + if ($clientSecret !== null) { + $query->where('oauth_clients.secret', $clientSecret); + } + + if ($redirectUri) { + $query->join('oauth_client_redirect_uris', 'oauth_clients.id', '=', 'oauth_client_redirect_uris.client_id') + ->select(['oauth_clients.*', 'oauth_client_redirect_uris.*']) + ->where('oauth_client_redirect_uris.redirect_uri', $redirectUri); + } + + $result = $query->get(); + + if (count($result) === 1) { + $client = new ClientEntity($this->server); + $client->hydrate([ + 'id' => $result[0]['id'], + 'name' => $result[0]['name'], + ]); + + return $client; + } + + return; + } + + /** + * {@inheritdoc} + */ + public function getBySession(SessionEntity $session) + { + $result = Capsule::table('oauth_clients') + ->select(['oauth_clients.id', 'oauth_clients.name']) + ->join('oauth_sessions', 'oauth_clients.id', '=', 'oauth_sessions.client_id') + ->where('oauth_sessions.id', $session->getId()) + ->get(); + + if (count($result) === 1) { + $client = new ClientEntity($this->server); + $client->hydrate([ + 'id' => $result[0]['id'], + 'name' => $result[0]['name'], + ]); + + return $client; + } + + return; + } +} diff --git a/examples/relational/Storage/RefreshTokenStorage.php b/examples/relational/Storage/RefreshTokenStorage.php new file mode 100644 index 0000000..580efaf --- /dev/null +++ b/examples/relational/Storage/RefreshTokenStorage.php @@ -0,0 +1,55 @@ +where('refresh_token', $token) + ->get(); + + if (count($result) === 1) { + $token = (new RefreshTokenEntity($this->server)) + ->setId($result[0]['refresh_token']) + ->setExpireTime($result[0]['expire_time']) + ->setAccessTokenId($result[0]['access_token']); + + return $token; + } + + return; + } + + /** + * {@inheritdoc} + */ + public function create($token, $expireTime, $accessToken) + { + Capsule::table('oauth_refresh_tokens') + ->insert([ + 'refresh_token' => $token, + 'access_token' => $accessToken, + 'expire_time' => $expireTime, + ]); + } + + /** + * {@inheritdoc} + */ + public function delete(RefreshTokenEntity $token) + { + Capsule::table('oauth_refresh_tokens') + ->where('refresh_token', $token->getId()) + ->delete(); + } +} diff --git a/examples/relational/Storage/ScopeStorage.php b/examples/relational/Storage/ScopeStorage.php new file mode 100644 index 0000000..4a6dd20 --- /dev/null +++ b/examples/relational/Storage/ScopeStorage.php @@ -0,0 +1,30 @@ +where('id', $scope) + ->get(); + + if (count($result) === 0) { + return; + } + + return (new ScopeEntity($this->server))->hydrate([ + 'id' => $result[0]['id'], + 'description' => $result[0]['description'], + ]); + } +} diff --git a/examples/relational/Storage/SessionStorage.php b/examples/relational/Storage/SessionStorage.php new file mode 100644 index 0000000..612b148 --- /dev/null +++ b/examples/relational/Storage/SessionStorage.php @@ -0,0 +1,109 @@ +select(['oauth_sessions.id', 'oauth_sessions.owner_type', 'oauth_sessions.owner_id', 'oauth_sessions.client_id', 'oauth_sessions.client_redirect_uri']) + ->join('oauth_access_tokens', 'oauth_access_tokens.session_id', '=', 'oauth_sessions.id') + ->where('oauth_access_tokens.access_token', $accessToken->getId()) + ->get(); + + if (count($result) === 1) { + $session = new SessionEntity($this->server); + $session->setId($result[0]['id']); + $session->setOwner($result[0]['owner_type'], $result[0]['owner_id']); + + return $session; + } + + return; + } + + /** + * {@inheritdoc} + */ + public function getByAuthCode(AuthCodeEntity $authCode) + { + $result = Capsule::table('oauth_sessions') + ->select(['oauth_sessions.id', 'oauth_sessions.owner_type', 'oauth_sessions.owner_id', 'oauth_sessions.client_id', 'oauth_sessions.client_redirect_uri']) + ->join('oauth_auth_codes', 'oauth_auth_codes.session_id', '=', 'oauth_sessions.id') + ->where('oauth_auth_codes.auth_code', $authCode->getId()) + ->get(); + + if (count($result) === 1) { + $session = new SessionEntity($this->server); + $session->setId($result[0]['id']); + $session->setOwner($result[0]['owner_type'], $result[0]['owner_id']); + + return $session; + } + + return; + } + + /** + * {@inheritdoc} + */ + public function getScopes(SessionEntity $session) + { + $result = Capsule::table('oauth_sessions') + ->select('oauth_scopes.*') + ->join('oauth_session_scopes', 'oauth_sessions.id', '=', 'oauth_session_scopes.session_id') + ->join('oauth_scopes', 'oauth_scopes.id', '=', 'oauth_session_scopes.scope') + ->where('oauth_sessions.id', $session->getId()) + ->get(); + + $scopes = []; + + foreach ($result as $scope) { + $scopes[] = (new ScopeEntity($this->server))->hydrate([ + 'id' => $scope['id'], + 'description' => $scope['description'], + ]); + } + + return $scopes; + } + + /** + * {@inheritdoc} + */ + public function create($ownerType, $ownerId, $clientId, $clientRedirectUri = null) + { + $id = Capsule::table('oauth_sessions') + ->insertGetId([ + 'owner_type' => $ownerType, + 'owner_id' => $ownerId, + 'client_id' => $clientId, + ]); + + return $id; + } + + /** + * {@inheritdoc} + */ + public function associateScope(SessionEntity $session, ScopeEntity $scope) + { + Capsule::table('oauth_session_scopes') + ->insert([ + 'session_id' => $session->getId(), + 'scope' => $scope->getId(), + ]); + } +} diff --git a/examples/relational/api.php b/examples/relational/api.php new file mode 100644 index 0000000..d05d225 --- /dev/null +++ b/examples/relational/api.php @@ -0,0 +1,130 @@ +createFromGlobals(); +$router = new \Orno\Route\RouteCollection(); + +// GET /tokeninfo +$router->get('/tokeninfo', function (Request $request) use ($server) { + + $accessToken = $server->getAccessToken(); + $session = $server->getSessionStorage()->getByAccessToken($accessToken); + $token = [ + 'owner_id' => $session->getOwnerId(), + 'owner_type' => $session->getOwnerType(), + 'access_token' => $accessToken, + 'client_id' => $session->getClient()->getId(), + 'scopes' => $accessToken->getScopes(), + ]; + + return new Response(json_encode($token)); + +}); + +// GET /users +$router->get('/users', function (Request $request) use ($server) { + + $results = (new Model\Users())->get(); + + $users = []; + + foreach ($results as $result) { + $user = [ + 'username' => $result['username'], + 'name' => $result['name'], + ]; + + if ($server->getAccessToken()->hasScope('email')) { + $user['email'] = $result['email']; + } + + if ($server->getAccessToken()->hasScope('photo')) { + $user['photo'] = $result['photo']; + } + + $users[] = $user; + } + + return new Response(json_encode($users)); +}); + +// GET /users/{username} +$router->get('/users/{username}', function (Request $request, Response $response, array $args) use ($server) { + + $result = (new Model\Users())->get($args['username']); + + if (count($result) === 0) { + throw new NotFoundException(); + } + + $user = [ + 'username' => $result[0]['username'], + 'name' => $result[0]['name'], + ]; + + if ($server->getAccessToken()->hasScope('email')) { + $user['email'] = $result[0]['email']; + } + + if ($server->getAccessToken()->hasScope('photo')) { + $user['photo'] = $result[0]['photo']; + } + + return new Response(json_encode($user)); +}); + +$dispatcher = $router->getDispatcher(); + +try { + // Check that access token is present + $server->isValidRequest(false); + + // A successful response + $response = $dispatcher->dispatch( + $request->getMethod(), + $request->getPathInfo() + ); +} catch (\Orno\Http\Exception $e) { + // A failed response + $response = $e->getJsonResponse(); + $response->setContent(json_encode(['status_code' => $e->getStatusCode(), 'message' => $e->getMessage()])); +} catch (\League\OAuth2\Server\Exception\OAuthException $e) { + $response = new Response(json_encode([ + 'error' => $e->errorType, + 'message' => $e->getMessage(), + ]), $e->httpStatusCode); + + foreach ($e->getHttpHeaders() as $header) { + $response->headers($header); + } +} catch (\Exception $e) { + $response = new Orno\Http\Response(); + $response->setStatusCode(500); + $response->setContent(json_encode(['status_code' => 500, 'message' => $e->getMessage()])); +} finally { + // Return the response + $response->headers->set('Content-type', 'application/json'); + $response->send(); +} diff --git a/examples/relational/authcode_grant.php b/examples/relational/authcode_grant.php new file mode 100644 index 0000000..380025e --- /dev/null +++ b/examples/relational/authcode_grant.php @@ -0,0 +1,117 @@ +createFromGlobals(); +$router = new \Orno\Route\RouteCollection(); +$router->setStrategy(\Orno\Route\RouteStrategyInterface::RESTFUL_STRATEGY); + +// Set up the OAuth 2.0 authorization server +$server = new \League\OAuth2\Server\AuthorizationServer(); +$server->setSessionStorage(new Storage\SessionStorage()); +$server->setAccessTokenStorage(new Storage\AccessTokenStorage()); +$server->setRefreshTokenStorage(new Storage\RefreshTokenStorage()); +$server->setClientStorage(new Storage\ClientStorage()); +$server->setScopeStorage(new Storage\ScopeStorage()); +$server->setAuthCodeStorage(new Storage\AuthCodeStorage()); + +$authCodeGrant = new \League\OAuth2\Server\Grant\AuthCodeGrant(); +$server->addGrantType($authCodeGrant); + +$refrehTokenGrant = new \League\OAuth2\Server\Grant\RefreshTokenGrant(); +$server->addGrantType($refrehTokenGrant); + +// Routing setup +$request = (new Request())->createFromGlobals(); +$router = new \Orno\Route\RouteCollection(); + +$router->get('/authorize', function (Request $request) use ($server) { + + // First ensure the parameters in the query string are correct + + try { + $authParams = $server->getGrantType('authorization_code')->checkAuthorizeParams(); + } catch (\Exception $e) { + return new Response( + json_encode([ + 'error' => $e->errorType, + 'message' => $e->getMessage(), + ]), + $e->httpStatusCode, + $e->getHttpHeaders() + ); + } + + // Normally at this point you would show the user a sign-in screen and ask them to authorize the requested scopes + + // ... + + // ... + + // ... + + // Create a new authorize request which will respond with a redirect URI that the user will be redirected to + + $redirectUri = $server->getGrantType('authorization_code')->newAuthorizeRequest('user', 1, $authParams); + + $response = new Response('', 200, [ + 'Location' => $redirectUri + ]); + + return $response; +}); + +$router->post('/access_token', function (Request $request) use ($server) { + + try { + $response = $server->issueAccessToken(); + + return new Response(json_encode($response), 200); + } catch (\Exception $e) { + return new Response( + json_encode([ + 'error' => $e->errorType, + 'message' => $e->getMessage(), + ]), + $e->httpStatusCode, + $e->getHttpHeaders() + ); + } + +}); + +$dispatcher = $router->getDispatcher(); + +try { + // A successful response + $response = $dispatcher->dispatch( + $request->getMethod(), + $request->getPathInfo() + ); +} catch (\Orno\Http\Exception $e) { + // A failed response + $response = $e->getJsonResponse(); + $response->setContent(json_encode(['status_code' => $e->getStatusCode(), 'message' => $e->getMessage()])); +} catch (\League\OAuth2\Server\Exception\OAuthException $e) { + $response = new Response(json_encode([ + 'error' => $e->errorType, + 'message' => $e->getMessage(), + ]), $e->httpStatusCode); + + foreach ($e->getHttpHeaders() as $header) { + $response->headers($header); + } +} catch (\Exception $e) { + $response = new Orno\Http\Response(); + $response->setStatusCode(500); + $response->setContent(json_encode(['status_code' => 500, 'message' => $e->getMessage()])); +} finally { + // Return the response + $response->headers->set('Content-type', 'application/json'); + $response->send(); +} diff --git a/examples/relational/composer.json b/examples/relational/composer.json new file mode 100644 index 0000000..34bd57c --- /dev/null +++ b/examples/relational/composer.json @@ -0,0 +1,17 @@ +{ + "require": { + "illuminate/database": "4.1.*", + "orno/route": "1.*", + "ircmaxell/password-compat": "1.0.2", + "league/event": "0.2.0" + }, + "autoload": { + "psr-4": { + "League\\OAuth2\\Server\\": "../../src/", + "RelationalExample\\": "." + }, + "files": [ + "config/db.php" + ] + } +} \ No newline at end of file diff --git a/examples/relational/config/db.php b/examples/relational/config/db.php new file mode 100644 index 0000000..de88397 --- /dev/null +++ b/examples/relational/config/db.php @@ -0,0 +1,18 @@ +addConnection([ + 'driver' => 'sqlite', + 'database' => __DIR__.'/oauth2.sqlite3', + 'charset' => 'utf8', + 'collation' => 'utf8_unicode_ci', +]); + +$capsule->setAsGlobal(); diff --git a/examples/relational/config/init.php b/examples/relational/config/init.php new file mode 100644 index 0000000..85ba40f --- /dev/null +++ b/examples/relational/config/init.php @@ -0,0 +1,249 @@ +create('users', function ($table) { + $table->increments('id'); + $table->string('username'); + $table->string('password'); + $table->string('name'); + $table->string('email'); + $table->string('photo'); +}); + +Capsule::table('users')->insert([ + 'username' => 'alexbilbie', + 'password' => password_hash('whisky', PASSWORD_DEFAULT), + 'name' => 'Alex Bilbie', + 'email' => 'hello@alexbilbie.com', + 'photo' => 'https://s.gravatar.com/avatar/14902eb1dac66b8458ebbb481d80f0a3', +]); + +Capsule::table('users')->insert([ + 'username' => 'philsturgeon', + 'password' => password_hash('cider', PASSWORD_DEFAULT), + 'name' => 'Phil Sturgeon', + 'email' => 'email@philsturgeon.co.uk', + 'photo' => 'https://s.gravatar.com/avatar/14df293d6c5cd6f05996dfc606a6a951', +]); + +/******************************************************************************/ + +print 'Creating clients table'.PHP_EOL; + +Capsule::schema()->create('oauth_clients', function ($table) { + $table->string('id'); + $table->string('secret'); + $table->string('name'); + $table->primary('id'); +}); + +Capsule::table('oauth_clients')->insert([ + 'id' => 'testclient', + 'secret' => 'secret', + 'name' => 'Test Client', +]); + +/******************************************************************************/ + +print 'Creating client redirect uris table'.PHP_EOL; + +Capsule::schema()->create('oauth_client_redirect_uris', function ($table) { + $table->increments('id'); + $table->string('client_id'); + $table->string('redirect_uri'); +}); + +Capsule::table('oauth_client_redirect_uris')->insert([ + 'client_id' => 'testclient', + 'redirect_uri' => 'http://example.com/redirect', +]); + +/******************************************************************************/ + +print 'Creating scopes table'.PHP_EOL; + +Capsule::schema()->create('oauth_scopes', function ($table) { + $table->string('id'); + $table->string('description'); + $table->primary('id'); +}); + +Capsule::table('oauth_scopes')->insert([ + 'id' => 'basic', + 'description' => 'Basic details about your account', +]); + +Capsule::table('oauth_scopes')->insert([ + 'id' => 'email', + 'description' => 'Your email address', +]); + +Capsule::table('oauth_scopes')->insert([ + 'id' => 'photo', + 'description' => 'Your photo', +]); + +/******************************************************************************/ + +print 'Creating sessions table'.PHP_EOL; + +Capsule::schema()->create('oauth_sessions', function ($table) { + $table->increments('id')->unsigned(); + $table->string('owner_type'); + $table->string('owner_id'); + $table->string('client_id'); + $table->string('client_redirect_uri')->nullable(); + + $table->foreign('client_id')->references('id')->on('oauth_clients')->onDelete('cascade'); +}); + +Capsule::table('oauth_sessions')->insert([ + 'owner_type' => 'client', + 'owner_id' => 'testclient', + 'client_id' => 'testclient', +]); + +Capsule::table('oauth_sessions')->insert([ + 'owner_type' => 'user', + 'owner_id' => '1', + 'client_id' => 'testclient', +]); + +Capsule::table('oauth_sessions')->insert([ + 'owner_type' => 'user', + 'owner_id' => '2', + 'client_id' => 'testclient', +]); + +/******************************************************************************/ + +print 'Creating access tokens table'.PHP_EOL; + +Capsule::schema()->create('oauth_access_tokens', function ($table) { + $table->string('access_token')->primary(); + $table->integer('session_id')->unsigned(); + $table->integer('expire_time'); + + $table->foreign('session_id')->references('id')->on('oauth_sessions')->onDelete('cascade'); +}); + +Capsule::table('oauth_access_tokens')->insert([ + 'access_token' => 'iamgod', + 'session_id' => '1', + 'expire_time' => time() + 86400, +]); + +Capsule::table('oauth_access_tokens')->insert([ + 'access_token' => 'iamalex', + 'session_id' => '2', + 'expire_time' => time() + 86400, +]); + +Capsule::table('oauth_access_tokens')->insert([ + 'access_token' => 'iamphil', + 'session_id' => '3', + 'expire_time' => time() + 86400, +]); + +/******************************************************************************/ + +print 'Creating refresh tokens table'.PHP_EOL; + +Capsule::schema()->create('oauth_refresh_tokens', function ($table) { + $table->string('refresh_token')->primary(); + $table->integer('expire_time'); + $table->string('access_token'); + + $table->foreign('access_token')->references('access_token')->on('oauth_access_tokens')->onDelete('cascade'); +}); + +/******************************************************************************/ + +print 'Creating auth codes table'.PHP_EOL; + +Capsule::schema()->create('oauth_auth_codes', function ($table) { + $table->string('auth_code')->primary(); + $table->integer('session_id')->unsigned(); + $table->integer('expire_time'); + $table->string('client_redirect_uri'); + + $table->foreign('session_id')->references('id')->on('oauth_sessions')->onDelete('cascade'); +}); + +/******************************************************************************/ + +print 'Creating oauth access token scopes table'.PHP_EOL; + +Capsule::schema()->create('oauth_access_token_scopes', function ($table) { + $table->increments('id')->unsigned(); + $table->string('access_token'); + $table->string('scope'); + + $table->foreign('access_token')->references('access_token')->on('oauth_access_tokens')->onDelete('cascade'); + $table->foreign('scope')->references('id')->on('oauth_scopes')->onDelete('cascade'); +}); + +Capsule::table('oauth_access_token_scopes')->insert([ + 'access_token' => 'iamgod', + 'scope' => 'basic', +]); + +Capsule::table('oauth_access_token_scopes')->insert([ + 'access_token' => 'iamgod', + 'scope' => 'email', +]); + +Capsule::table('oauth_access_token_scopes')->insert([ + 'access_token' => 'iamgod', + 'scope' => 'photo', +]); + +Capsule::table('oauth_access_token_scopes')->insert([ + 'access_token' => 'iamphil', + 'scope' => 'email', +]); + +Capsule::table('oauth_access_token_scopes')->insert([ + 'access_token' => 'iamalex', + 'scope' => 'photo', +]); + +/******************************************************************************/ + +print 'Creating oauth auth code scopes table'.PHP_EOL; + +Capsule::schema()->create('oauth_auth_code_scopes', function ($table) { + $table->increments('id'); + $table->string('auth_code'); + $table->string('scope'); + + $table->foreign('auth_code')->references('auth_code')->on('oauth_auth_codes')->onDelete('cascade'); + $table->foreign('scope')->references('id')->on('oauth_scopes')->onDelete('cascade'); +}); + +/******************************************************************************/ + +print 'Creating oauth session scopes table'.PHP_EOL; + +Capsule::schema()->create('oauth_session_scopes', function ($table) { + $table->increments('id')->unsigned(); + $table->integer('session_id')->unsigned(); + $table->string('scope'); + + $table->foreign('session_id')->references('id')->on('oauth_sessions')->onDelete('cascade'); + $table->foreign('scope')->references('id')->on('oauth_scopes')->onDelete('cascade'); +}); diff --git a/examples/relational/other_grants.php b/examples/relational/other_grants.php new file mode 100644 index 0000000..a59d201 --- /dev/null +++ b/examples/relational/other_grants.php @@ -0,0 +1,97 @@ +createFromGlobals(); +$router = new \Orno\Route\RouteCollection(); +$router->setStrategy(\Orno\Route\RouteStrategyInterface::RESTFUL_STRATEGY); + +// Set up the OAuth 2.0 authorization server +$server = new \League\OAuth2\Server\AuthorizationServer(); +$server->setSessionStorage(new Storage\SessionStorage()); +$server->setAccessTokenStorage(new Storage\AccessTokenStorage()); +$server->setRefreshTokenStorage(new Storage\RefreshTokenStorage()); +$server->setClientStorage(new Storage\ClientStorage()); +$server->setScopeStorage(new Storage\ScopeStorage()); +$server->setAuthCodeStorage(new Storage\AuthCodeStorage()); + +$clientCredentials = new \League\OAuth2\Server\Grant\ClientCredentialsGrant(); +$server->addGrantType($clientCredentials); + +$passwordGrant = new \League\OAuth2\Server\Grant\PasswordGrant(); +$passwordGrant->setVerifyCredentialsCallback(function ($username, $password) { + $result = (new Model\Users())->get($username); + if (count($result) !== 1) { + return false; + } + + if (password_verify($password, $result[0]['password'])) { + return $username; + } + + return false; +}); +$server->addGrantType($passwordGrant); + +$refrehTokenGrant = new \League\OAuth2\Server\Grant\RefreshTokenGrant(); +$server->addGrantType($refrehTokenGrant); + +// Routing setup +$request = (new Request())->createFromGlobals(); +$router = new \Orno\Route\RouteCollection(); + +$router->post('/access_token', function (Request $request) use ($server) { + + try { + $response = $server->issueAccessToken(); + + return new Response(json_encode($response), 200); + } catch (\Exception $e) { + return new Response( + json_encode([ + 'error' => $e->errorType, + 'message' => $e->getMessage(), + ]), + $e->httpStatusCode, + $e->getHttpHeaders() + ); + } + +}); + +$dispatcher = $router->getDispatcher(); + +try { + // A successful response + $response = $dispatcher->dispatch( + $request->getMethod(), + $request->getPathInfo() + ); +} catch (\Orno\Http\Exception $e) { + // A failed response + $response = $e->getJsonResponse(); + $response->setContent(json_encode(['status_code' => $e->getStatusCode(), 'message' => $e->getMessage()])); +} catch (\League\OAuth2\Server\Exception\OAuthException $e) { + $response = new Response(json_encode([ + 'error' => $e->errorType, + 'message' => $e->getMessage(), + ]), $e->httpStatusCode); + + foreach ($e->getHttpHeaders() as $header) { + $response->headers($header); + } +} catch (\Exception $e) { + $response = new Orno\Http\Response(); + $response->setStatusCode(500); + $response->setContent(json_encode(['status_code' => 500, 'message' => $e->getMessage()])); +} finally { + // Return the response + $response->headers->set('Content-type', 'application/json'); + $response->send(); +} diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..a4f444b --- /dev/null +++ b/license.txt @@ -0,0 +1,20 @@ +MIT License + +Copyright (C) Alex Bilbie + +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. \ No newline at end of file diff --git a/src/AbstractServer.php b/src/AbstractServer.php new file mode 100644 index 0000000..ec4b2ae --- /dev/null +++ b/src/AbstractServer.php @@ -0,0 +1,358 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server; + +use League\Event\Emitter; +use League\OAuth2\Server\Storage\AccessTokenInterface; +use League\OAuth2\Server\Storage\AuthCodeInterface; +use League\OAuth2\Server\Storage\ClientInterface; +use League\OAuth2\Server\Storage\MacTokenInterface; +use League\OAuth2\Server\Storage\RefreshTokenInterface; +use League\OAuth2\Server\Storage\ScopeInterface; +use League\OAuth2\Server\Storage\SessionInterface; +use League\OAuth2\Server\TokenType\TokenTypeInterface; +use Symfony\Component\HttpFoundation\Request; + +/** + * OAuth 2.0 Resource Server + */ +abstract class AbstractServer +{ + /** + * The request object + * + * @var \Symfony\Component\HttpFoundation\Request + */ + protected $request; + + /** + * Session storage + * + * @var \League\OAuth2\Server\Storage\SessionInterface + */ + protected $sessionStorage; + + /** + * Access token storage + * + * @var \League\OAuth2\Server\Storage\AccessTokenInterface + */ + protected $accessTokenStorage; + + /** + * Refresh token storage + * + * @var \League\OAuth2\Server\Storage\RefreshTokenInterface + */ + protected $refreshTokenStorage; + + /** + * Auth code storage + * + * @var \League\OAuth2\Server\Storage\AuthCodeInterface + */ + protected $authCodeStorage; + + /** + * Scope storage + * + * @var \League\OAuth2\Server\Storage\ScopeInterface + */ + protected $scopeStorage; + + /** + * Client storage + * + * @var \League\OAuth2\Server\Storage\ClientInterface + */ + protected $clientStorage; + + /** + * @var \League\OAuth2\Server\Storage\MacTokenInterface + */ + protected $macStorage; + + /** + * Token type + * + * @var \League\OAuth2\Server\TokenType\TokenTypeInterface + */ + protected $tokenType; + + /** + * Event emitter + * + * @var \League\Event\Emitter + */ + protected $eventEmitter; + + /** + * Abstract server constructor + */ + public function __construct() + { + $this->setEventEmitter(); + } + + /** + * Set an event emitter + * + * @param object $emitter Event emitter object + */ + public function setEventEmitter($emitter = null) + { + if ($emitter === null) { + $this->eventEmitter = new Emitter(); + } else { + $this->eventEmitter = $emitter; + } + } + + /** + * Add an event listener to the event emitter + * + * @param string $eventName Event name + * @param callable $listener Callable function or method + * @param int $priority Priority of event listener + */ + public function addEventListener($eventName, callable $listener, $priority = Emitter::P_NORMAL) + { + $this->eventEmitter->addListener($eventName, $listener, $priority); + } + + /** + * Returns the event emitter + * + * @return \League\Event\Emitter + */ + public function getEventEmitter() + { + return $this->eventEmitter; + } + + /** + * Sets the Request Object + * + * @param \Symfony\Component\HttpFoundation\Request The Request Object + * + * @return self + */ + public function setRequest($request) + { + $this->request = $request; + + return $this; + } + + /** + * Gets the Request object. It will create one from the globals if one is not set. + * + * @return \Symfony\Component\HttpFoundation\Request + */ + public function getRequest() + { + if ($this->request === null) { + $this->request = Request::createFromGlobals(); + } + + return $this->request; + } + + /** + * Set the client storage + * + * @param \League\OAuth2\Server\Storage\ClientInterface $storage + * + * @return self + */ + public function setClientStorage(ClientInterface $storage) + { + $storage->setServer($this); + $this->clientStorage = $storage; + + return $this; + } + + /** + * Set the session storage + * + * @param \League\OAuth2\Server\Storage\SessionInterface $storage + * + * @return self + */ + public function setSessionStorage(SessionInterface $storage) + { + $storage->setServer($this); + $this->sessionStorage = $storage; + + return $this; + } + + /** + * Set the access token storage + * + * @param \League\OAuth2\Server\Storage\AccessTokenInterface $storage + * + * @return self + */ + public function setAccessTokenStorage(AccessTokenInterface $storage) + { + $storage->setServer($this); + $this->accessTokenStorage = $storage; + + return $this; + } + + /** + * Set the refresh token storage + * + * @param \League\OAuth2\Server\Storage\RefreshTokenInterface $storage + * + * @return self + */ + public function setRefreshTokenStorage(RefreshTokenInterface $storage) + { + $storage->setServer($this); + $this->refreshTokenStorage = $storage; + + return $this; + } + + /** + * Set the auth code storage + * + * @param \League\OAuth2\Server\Storage\AuthCodeInterface $storage + * + * @return self + */ + public function setAuthCodeStorage(AuthCodeInterface $storage) + { + $storage->setServer($this); + $this->authCodeStorage = $storage; + + return $this; + } + + /** + * Set the scope storage + * + * @param \League\OAuth2\Server\Storage\ScopeInterface $storage + * + * @return self + */ + public function setScopeStorage(ScopeInterface $storage) + { + $storage->setServer($this); + $this->scopeStorage = $storage; + + return $this; + } + + /** + * Return the client storage + * + * @return \League\OAuth2\Server\Storage\ClientInterface + */ + public function getClientStorage() + { + return $this->clientStorage; + } + + /** + * Return the scope storage + * + * @return \League\OAuth2\Server\Storage\ScopeInterface + */ + public function getScopeStorage() + { + return $this->scopeStorage; + } + + /** + * Return the session storage + * + * @return \League\OAuth2\Server\Storage\SessionInterface + */ + public function getSessionStorage() + { + return $this->sessionStorage; + } + + /** + * Return the refresh token storage + * + * @return \League\OAuth2\Server\Storage\RefreshTokenInterface + */ + public function getRefreshTokenStorage() + { + return $this->refreshTokenStorage; + } + + /** + * Return the access token storage + * + * @return \League\OAuth2\Server\Storage\AccessTokenInterface + */ + public function getAccessTokenStorage() + { + return $this->accessTokenStorage; + } + + /** + * Return the auth code storage + * + * @return \League\OAuth2\Server\Storage\AuthCodeInterface + */ + public function getAuthCodeStorage() + { + return $this->authCodeStorage; + } + + /** + * Set the access token type + * + * @param TokenTypeInterface $tokenType The token type + * + * @return void + */ + public function setTokenType(TokenTypeInterface $tokenType) + { + $tokenType->setServer($this); + $this->tokenType = $tokenType; + } + + /** + * Get the access token type + * + * @return TokenTypeInterface + */ + public function getTokenType() + { + return $this->tokenType; + } + + /** + * @return MacTokenInterface + */ + public function getMacStorage() + { + return $this->macStorage; + } + + /** + * @param MacTokenInterface $macStorage + */ + public function setMacStorage(MacTokenInterface $macStorage) + { + $this->macStorage = $macStorage; + } +} diff --git a/src/AuthorizationServer.php b/src/AuthorizationServer.php new file mode 100644 index 0000000..d75213e --- /dev/null +++ b/src/AuthorizationServer.php @@ -0,0 +1,295 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server; + +use League\OAuth2\Server\Grant\GrantTypeInterface; +use League\OAuth2\Server\TokenType\Bearer; + +/** + * OAuth 2.0 authorization server class + */ +class AuthorizationServer extends AbstractServer +{ + /** + * The delimiter between scopes specified in the scope query string parameter + * The OAuth 2 specification states it should be a space but most use a comma + * + * @var string + */ + protected $scopeDelimiter = ' '; + + /** + * The TTL (time to live) of an access token in seconds (default: 3600) + * + * @var integer + */ + protected $accessTokenTTL = 3600; + + /** + * The registered grant response types + * + * @var array + */ + protected $responseTypes = []; + + /** + * The registered grant types + * + * @var array + */ + protected $grantTypes = []; + + /** + * Require the "scope" parameter to be in checkAuthoriseParams() + * + * @var boolean + */ + protected $requireScopeParam = false; + + /** + * Default scope(s) to be used if none is provided + * + * @var string|array + */ + protected $defaultScope; + + /** + * Require the "state" parameter to be in checkAuthoriseParams() + * + * @var boolean + */ + protected $requireStateParam = false; + + /** + * Create a new OAuth2 authorization server + * + * @return self + */ + public function __construct() + { + // Set Bearer as the default token type + $this->setTokenType(new Bearer()); + + parent::__construct(); + + return $this; + } + + /** + * Enable support for a grant + * + * @param GrantTypeInterface $grantType A grant class which conforms to Interface/GrantTypeInterface + * @param null|string $identifier An identifier for the grant (autodetected if not passed) + * + * @return self + */ + public function addGrantType(GrantTypeInterface $grantType, $identifier = null) + { + if (is_null($identifier)) { + $identifier = $grantType->getIdentifier(); + } + + // Inject server into grant + $grantType->setAuthorizationServer($this); + + $this->grantTypes[$identifier] = $grantType; + + if (!is_null($grantType->getResponseType())) { + $this->responseTypes[] = $grantType->getResponseType(); + } + + return $this; + } + + /** + * Check if a grant type has been enabled + * + * @param string $identifier The grant type identifier + * + * @return boolean Returns "true" if enabled, "false" if not + */ + public function hasGrantType($identifier) + { + return (array_key_exists($identifier, $this->grantTypes)); + } + + /** + * Returns response types + * + * @return array + */ + public function getResponseTypes() + { + return $this->responseTypes; + } + + /** + * Require the "scope" parameter in checkAuthoriseParams() + * + * @param boolean $require + * + * @return self + */ + public function requireScopeParam($require = true) + { + $this->requireScopeParam = $require; + + return $this; + } + + /** + * Is the scope parameter required? + * + * @return bool + */ + public function scopeParamRequired() + { + return $this->requireScopeParam; + } + + /** + * Default scope to be used if none is provided and requireScopeParam() is false + * + * @param string $default Name of the default scope + * + * @return self + */ + public function setDefaultScope($default = null) + { + $this->defaultScope = $default; + + return $this; + } + + /** + * Default scope to be used if none is provided and requireScopeParam is false + * + * @return string|null + */ + public function getDefaultScope() + { + return $this->defaultScope; + } + + /** + * Require the "state" parameter in checkAuthoriseParams() + * + * @return bool + */ + public function stateParamRequired() + { + return $this->requireStateParam; + } + + /** + * Require the "state" parameter in checkAuthoriseParams() + * + * @param boolean $require + * + * @return self + */ + public function requireStateParam($require = true) + { + $this->requireStateParam = $require; + + return $this; + } + + /** + * Get the scope delimiter + * + * @return string The scope delimiter (default: ",") + */ + public function getScopeDelimiter() + { + return $this->scopeDelimiter; + } + + /** + * Set the scope delimiter + * + * @param string $scopeDelimiter + * + * @return self + */ + public function setScopeDelimiter($scopeDelimiter = ' ') + { + $this->scopeDelimiter = $scopeDelimiter; + + return $this; + } + + /** + * Get the TTL for an access token + * + * @return int The TTL + */ + public function getAccessTokenTTL() + { + return $this->accessTokenTTL; + } + + /** + * Set the TTL for an access token + * + * @param int $accessTokenTTL The new TTL + * + * @return self + */ + public function setAccessTokenTTL($accessTokenTTL = 3600) + { + $this->accessTokenTTL = $accessTokenTTL; + + return $this; + } + + /** + * Issue an access token + * + * @return array Authorise request parameters + * + * @throws + */ + public function issueAccessToken() + { + $grantType = $this->getRequest()->request->get('grant_type'); + if (is_null($grantType)) { + throw new Exception\InvalidRequestException('grant_type'); + } + + // Ensure grant type is one that is recognised and is enabled + if (!in_array($grantType, array_keys($this->grantTypes))) { + throw new Exception\UnsupportedGrantTypeException($grantType); + } + + // Complete the flow + return $this->getGrantType($grantType)->completeFlow(); + } + + /** + * Return a grant type class + * + * @param string $grantType The grant type identifier + * + * @return Grant\GrantTypeInterface + * + * @throws + */ + public function getGrantType($grantType) + { + if (isset($this->grantTypes[$grantType])) { + return $this->grantTypes[$grantType]; + } + + throw new Exception\InvalidGrantException($grantType); + } +} diff --git a/src/Entity/AbstractTokenEntity.php b/src/Entity/AbstractTokenEntity.php new file mode 100644 index 0000000..5f0465c --- /dev/null +++ b/src/Entity/AbstractTokenEntity.php @@ -0,0 +1,209 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +use League\OAuth2\Server\AbstractServer; +use League\OAuth2\Server\Util\SecureKey; + +/** + * Abstract token class + */ +abstract class AbstractTokenEntity +{ + /** + * Token identifier + * + * @var string + */ + protected $id; + + /** + * Associated session + * + * @var \League\OAuth2\Server\Entity\SessionEntity + */ + protected $session; + + /** + * Session scopes + * + * @var \League\OAuth2\Server\Entity\ScopeEntity[] + */ + protected $scopes; + + /** + * Token expire time + * + * @var int + */ + protected $expireTime = 0; + + /** + * Authorization or resource server + * + * @var \League\OAuth2\Server\AbstractServer + */ + protected $server; + + /** + * __construct + * + * @param \League\OAuth2\Server\AbstractServer $server + * + * @return self + */ + public function __construct(AbstractServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * Set session + * + * @param \League\OAuth2\Server\Entity\SessionEntity $session + * + * @return self + */ + public function setSession(SessionEntity $session) + { + $this->session = $session; + + return $this; + } + + /** + * Set the expire time of the token + * + * @param integer $expireTime Unix time stamp + * + * @return self + */ + public function setExpireTime($expireTime) + { + $this->expireTime = $expireTime; + + return $this; + } + + /** + * Return token expire time + * + * @return int + */ + public function getExpireTime() + { + return $this->expireTime; + } + + /** + * Is the token expired? + * + * @return bool + */ + public function isExpired() + { + return ((time() - $this->expireTime) > 0); + } + + /** + * Set token ID + * + * @param string $id Token ID + * + * @return self + */ + public function setId($id = null) + { + $this->id = ($id !== null) ? $id : SecureKey::generate(); + + return $this; + } + + /** + * Get the token ID + * + * @return string + */ + public function getId() + { + return $this->id; + } + + /** + * Associate a scope + * + * @param \League\OAuth2\Server\Entity\ScopeEntity $scope + * + * @return self + */ + public function associateScope(ScopeEntity $scope) + { + if (!isset($this->scopes[$scope->getId()])) { + $this->scopes[$scope->getId()] = $scope; + } + + return $this; + } + + /** + * Format the local scopes array + * + * @param \League\OAuth2\Server\Entity\ScopeEntity[] + * + * @return array + */ + protected function formatScopes($unformatted = []) + { + if (is_null($unformatted)) { + return []; + } + + $scopes = []; + foreach ($unformatted as $scope) { + if ($scope instanceof ScopeEntity) { + $scopes[$scope->getId()] = $scope; + } + } + + return $scopes; + } + + /** + * Returns the token as a string if the object is cast as a string + * + * @return string + */ + public function __toString() + { + if ($this->id === null) { + return ''; + } + + return $this->id; + } + + /** + * Expire the token + * + * @return void + */ + abstract public function expire(); + + /** + * Save the token + * + * @return void + */ + abstract public function save(); +} diff --git a/src/Entity/AccessTokenEntity.php b/src/Entity/AccessTokenEntity.php new file mode 100644 index 0000000..7342b49 --- /dev/null +++ b/src/Entity/AccessTokenEntity.php @@ -0,0 +1,93 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +/** + * Access token entity class + */ +class AccessTokenEntity extends AbstractTokenEntity +{ + /** + * Get session + * + * @return \League\OAuth2\Server\Entity\SessionEntity + */ + public function getSession() + { + if ($this->session instanceof SessionEntity) { + return $this->session; + } + + $this->session = $this->server->getSessionStorage()->getByAccessToken($this); + + return $this->session; + } + + /** + * Check if access token has an associated scope + * + * @param string $scope Scope to check + * + * @return bool + */ + public function hasScope($scope) + { + if ($this->scopes === null) { + $this->getScopes(); + } + + return isset($this->scopes[$scope]); + } + + /** + * Return all scopes associated with the access token + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] + */ + public function getScopes() + { + if ($this->scopes === null) { + $this->scopes = $this->formatScopes( + $this->server->getAccessTokenStorage()->getScopes($this) + ); + } + + return $this->scopes; + } + + /** + * {@inheritdoc} + */ + public function save() + { + $this->server->getAccessTokenStorage()->create( + $this->getId(), + $this->getExpireTime(), + $this->getSession()->getId() + ); + + // Associate the scope with the token + foreach ($this->getScopes() as $scope) { + $this->server->getAccessTokenStorage()->associateScope($this, $scope); + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function expire() + { + $this->server->getAccessTokenStorage()->delete($this); + } +} diff --git a/src/Entity/AuthCodeEntity.php b/src/Entity/AuthCodeEntity.php new file mode 100644 index 0000000..5953aaf --- /dev/null +++ b/src/Entity/AuthCodeEntity.php @@ -0,0 +1,128 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +/** + * Auth Code entity class + */ +class AuthCodeEntity extends AbstractTokenEntity +{ + /** + * Redirect URI + * + * @var string + */ + protected $redirectUri = ''; + + /** + * Set the redirect URI for the authorization request + * + * @param string $redirectUri + * + * @return self + */ + public function setRedirectUri($redirectUri) + { + $this->redirectUri = $redirectUri; + + return $this; + } + + /** + * Get the redirect URI + * + * @return string + */ + public function getRedirectUri() + { + return $this->redirectUri; + } + + /** + * Generate a redirect URI + * + * @param string $state The state parameter if set by the client + * @param string $queryDelimeter The query delimiter ('?' for auth code grant, '#' for implicit grant) + * + * @return string + */ + public function generateRedirectUri($state = null, $queryDelimeter = '?') + { + $uri = $this->getRedirectUri(); + $uri .= (strstr($this->getRedirectUri(), $queryDelimeter) === false) ? $queryDelimeter : '&'; + + return $uri.http_build_query([ + 'code' => $this->getId(), + 'state' => $state, + ]); + } + + /** + * Get session + * + * @return \League\OAuth2\Server\Entity\SessionEntity + */ + public function getSession() + { + if ($this->session instanceof SessionEntity) { + return $this->session; + } + + $this->session = $this->server->getSessionStorage()->getByAuthCode($this); + + return $this->session; + } + + /** + * Return all scopes associated with the session + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] + */ + public function getScopes() + { + if ($this->scopes === null) { + $this->scopes = $this->formatScopes( + $this->server->getAuthCodeStorage()->getScopes($this) + ); + } + + return $this->scopes; + } + + /** + * {@inheritdoc} + */ + public function save() + { + $this->server->getAuthCodeStorage()->create( + $this->getId(), + $this->getExpireTime(), + $this->getSession()->getId(), + $this->getRedirectUri() + ); + + // Associate the scope with the token + foreach ($this->getScopes() as $scope) { + $this->server->getAuthCodeStorage()->associateScope($this, $scope); + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function expire() + { + $this->server->getAuthCodeStorage()->delete($this); + } +} diff --git a/src/Entity/ClientEntity.php b/src/Entity/ClientEntity.php new file mode 100644 index 0000000..b0e9528 --- /dev/null +++ b/src/Entity/ClientEntity.php @@ -0,0 +1,111 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +use League\OAuth2\Server\AbstractServer; + +/** + * Client entity class + */ +class ClientEntity +{ + use EntityTrait; + + /** + * Client identifier + * + * @var string + */ + protected $id = null; + + /** + * Client secret + * + * @var string + */ + protected $secret = null; + + /** + * Client name + * + * @var string + */ + protected $name = null; + + /** + * Client redirect URI + * + * @var string + */ + protected $redirectUri = null; + + /** + * Authorization or resource server + * + * @var \League\OAuth2\Server\AbstractServer + */ + protected $server; + + /** + * __construct + * + * @param \League\OAuth2\Server\AbstractServer $server + * + * @return self + */ + public function __construct(AbstractServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * Return the client identifier + * + * @return string + */ + public function getId() + { + return $this->id; + } + + /** + * Return the client secret + * + * @return string + */ + public function getSecret() + { + return $this->secret; + } + + /** + * Get the client name + * + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Returnt the client redirect URI + * + * @return string + */ + public function getRedirectUri() + { + return $this->redirectUri; + } +} diff --git a/src/Entity/EntityTrait.php b/src/Entity/EntityTrait.php new file mode 100644 index 0000000..9424fdf --- /dev/null +++ b/src/Entity/EntityTrait.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +trait EntityTrait +{ + /** + * Hydrate an entity with properites + * + * @param array $properties + * + * @return self + */ + public function hydrate(array $properties) + { + foreach ($properties as $prop => $val) { + if (property_exists($this, $prop)) { + $this->{$prop} = $val; + } + } + + return $this; + } +} diff --git a/src/Entity/RefreshTokenEntity.php b/src/Entity/RefreshTokenEntity.php new file mode 100644 index 0000000..f1ec89a --- /dev/null +++ b/src/Entity/RefreshTokenEntity.php @@ -0,0 +1,94 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +/** + * Refresh token entity class + */ +class RefreshTokenEntity extends AbstractTokenEntity +{ + /** + * Access token associated to refresh token + * + * @var \League\OAuth2\Server\Entity\AccessTokenEntity + */ + protected $accessTokenEntity; + + /** + * Id of the access token + * + * @var string + */ + protected $accessTokenId; + + /** + * Set the ID of the associated access token + * + * @param string $accessTokenId + * + * @return self + */ + public function setAccessTokenId($accessTokenId) + { + $this->accessTokenId = $accessTokenId; + + return $this; + } + + /** + * Associate an access token + * + * @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessTokenEntity + * + * @return self + */ + public function setAccessToken(AccessTokenEntity $accessTokenEntity) + { + $this->accessTokenEntity = $accessTokenEntity; + + return $this; + } + + /** + * Return access token + * + * @return AccessTokenEntity + */ + public function getAccessToken() + { + if (! $this->accessTokenEntity instanceof AccessTokenEntity) { + $this->accessTokenEntity = $this->server->getAccessTokenStorage()->get($this->accessTokenId); + } + + return $this->accessTokenEntity; + } + + /** + * {@inheritdoc} + */ + public function save() + { + $this->server->getRefreshTokenStorage()->create( + $this->getId(), + $this->getExpireTime(), + $this->getAccessToken()->getId() + ); + } + + /** + * {@inheritdoc} + */ + public function expire() + { + $this->server->getRefreshTokenStorage()->delete($this); + } +} diff --git a/src/Entity/ScopeEntity.php b/src/Entity/ScopeEntity.php new file mode 100644 index 0000000..1d5c946 --- /dev/null +++ b/src/Entity/ScopeEntity.php @@ -0,0 +1,90 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +use League\OAuth2\Server\AbstractServer; + +/** + * Scope entity class + */ +class ScopeEntity implements \JsonSerializable +{ + use EntityTrait; + + /** + * Scope identifier + * + * @var string + */ + protected $id; + + /** + * Scope description + * + * @var string + */ + protected $description; + + /** + * Authorization or resource server + * + * @var \League\OAuth2\Server\AbstractServer + */ + protected $server; + + /** + * __construct + * + * @param \League\OAuth2\Server\AbstractServer $server + * + * @return self + */ + public function __construct(AbstractServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * Return the scope identifer + * + * @return string + */ + public function getId() + { + return $this->id; + } + + /** + * Return the scope's description + * + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Returns a JSON object when entity is passed into json_encode + * + * @return array + */ + public function jsonSerialize() + { + return [ + 'id' => $this->getId(), + 'description' => $this->getDescription() + ]; + } +} diff --git a/src/Entity/SessionEntity.php b/src/Entity/SessionEntity.php new file mode 100644 index 0000000..198ca1f --- /dev/null +++ b/src/Entity/SessionEntity.php @@ -0,0 +1,318 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Entity; + +use League\OAuth2\Server\AbstractServer; +use League\OAuth2\Server\Event\SessionOwnerEvent; + +/** + * Session entity grant + */ +class SessionEntity +{ + /** + * Session identifier + * + * @var string + */ + protected $id; + + /** + * Client identifier + * + * @var \League\OAuth2\Server\Entity\ClientEntity + */ + protected $client; + + /** + * Session owner identifier + * + * @var string + */ + protected $ownerId; + + /** + * Session owner type (e.g. "user") + * + * @var string + */ + protected $ownerType; + + /** + * Auth code + * + * @var \League\OAuth2\Server\Entity\AuthCodeEntity + */ + protected $authCode; + + /** + * Access token + * + * @var \League\OAuth2\Server\Entity\AccessTokenEntity + */ + protected $accessToken; + + /** + * Refresh token + * + * @var \League\OAuth2\Server\Entity\RefreshTokenEntity + */ + protected $refreshToken; + + /** + * Session scopes + * + * @var \Symfony\Component\HttpFoundation\ParameterBag + */ + protected $scopes; + + /** + * Authorization or resource server + * + * @var \League\OAuth2\Server\AuthorizationServer|\League\OAuth2\Server\ResourceServer + */ + protected $server; + + /** + * __construct + * + * @param \League\OAuth2\Server\AbstractServer $server + * + * @return self + */ + public function __construct(AbstractServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * Set the session identifier + * + * @param string $id + * + * @return self + */ + public function setId($id) + { + $this->id = $id; + + return $this; + } + + /** + * Return the session identifier + * + * @return string + */ + public function getId() + { + return $this->id; + } + + /** + * Associate a scope + * + * @param \League\OAuth2\Server\Entity\ScopeEntity $scope + * + * @return self + */ + public function associateScope(ScopeEntity $scope) + { + if (!isset($this->scopes[$scope->getId()])) { + $this->scopes[$scope->getId()] = $scope; + } + + return $this; + } + + /** + * Check if access token has an associated scope + * + * @param string $scope Scope to check + * + * @return bool + */ + public function hasScope($scope) + { + if ($this->scopes === null) { + $this->getScopes(); + } + + return isset($this->scopes[$scope]); + } + + /** + * Return all scopes associated with the session + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] + */ + public function getScopes() + { + if ($this->scopes === null) { + $this->scopes = $this->formatScopes($this->server->getSessionStorage()->getScopes($this)); + } + + return $this->scopes; + } + + /** + * Format the local scopes array + * + * @param \League\OAuth2\Server\Entity\Scope[] + * + * @return array + */ + private function formatScopes($unformatted = []) + { + $scopes = []; + if (is_array($unformatted)) { + foreach ($unformatted as $scope) { + if ($scope instanceof ScopeEntity) { + $scopes[$scope->getId()] = $scope; + } + } + } + + return $scopes; + } + + /** + * Associate an access token with the session + * + * @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessToken + * + * @return self + */ + public function associateAccessToken(AccessTokenEntity $accessToken) + { + $this->accessToken = $accessToken; + + return $this; + } + + /** + * Associate a refresh token with the session + * + * @param \League\OAuth2\Server\Entity\RefreshTokenEntity $refreshToken + * + * @return self + */ + public function associateRefreshToken(RefreshTokenEntity $refreshToken) + { + $this->refreshToken = $refreshToken; + + return $this; + } + + /** + * Associate a client with the session + * + * @param \League\OAuth2\Server\Entity\ClientEntity $client The client + * + * @return self + */ + public function associateClient(ClientEntity $client) + { + $this->client = $client; + + return $this; + } + + /** + * Return the session client + * + * @return \League\OAuth2\Server\Entity\ClientEntity + */ + public function getClient() + { + if ($this->client instanceof ClientEntity) { + return $this->client; + } + + $this->client = $this->server->getClientStorage()->getBySession($this); + + return $this->client; + } + + /** + * Set the session owner + * + * @param string $type The type of the owner (e.g. user, app) + * @param string $id The identifier of the owner + * + * @return self + */ + public function setOwner($type, $id) + { + $this->ownerType = $type; + $this->ownerId = $id; + + $this->server->getEventEmitter()->emit(new SessionOwnerEvent($this)); + + return $this; + } + + /** + * Return session owner identifier + * + * @return string + */ + public function getOwnerId() + { + return $this->ownerId; + } + + /** + * Return session owner type + * + * @return string + */ + public function getOwnerType() + { + return $this->ownerType; + } + + /** + * Save the session + * + * @return void + */ + public function save() + { + // Save the session and get an identifier + $id = $this->server->getSessionStorage()->create( + $this->getOwnerType(), + $this->getOwnerId(), + $this->getClient()->getId(), + $this->getClient()->getRedirectUri() + ); + + $this->setId($id); + + // Associate the scope with the session + foreach ($this->getScopes() as $scope) { + $this->server->getSessionStorage()->associateScope($this, $scope); + } + } + + /** + * Delete the session + * + * @return void + */ + public function expire() + { + $this->server->getSessionStorage()->delete($this); + } +} diff --git a/src/Event/ClientAuthenticationFailedEvent.php b/src/Event/ClientAuthenticationFailedEvent.php new file mode 100644 index 0000000..4448bb4 --- /dev/null +++ b/src/Event/ClientAuthenticationFailedEvent.php @@ -0,0 +1,55 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Event; + +use League\Event\AbstractEvent; +use Symfony\Component\HttpFoundation\Request; + +class ClientAuthenticationFailedEvent extends AbstractEvent +{ + /** + * Request + * + * @var \Symfony\Component\HttpFoundation\Request + */ + private $request; + + /** + * Init the event with a request + * + * @param \Symfony\Component\HttpFoundation\Request $request + */ + public function __construct(Request $request) + { + $this->request = $request; + } + + /** + * The name of the event + * + * @return string + */ + public function getName() + { + return 'error.auth.client'; + } + + /** + * Return request + * + * @return \Symfony\Component\HttpFoundation\Request + */ + public function getRequest() + { + return $this->request; + } +} diff --git a/src/Event/SessionOwnerEvent.php b/src/Event/SessionOwnerEvent.php new file mode 100644 index 0000000..83c4e76 --- /dev/null +++ b/src/Event/SessionOwnerEvent.php @@ -0,0 +1,55 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Event; + +use League\Event\AbstractEvent; +use League\OAuth2\Server\Entity\SessionEntity; + +class SessionOwnerEvent extends AbstractEvent +{ + /** + * Session entity + * + * @var \League\OAuth2\Server\Entity\SessionEntity + */ + private $session; + + /** + * Init the event with a session + * + * @param \League\OAuth2\Server\Entity\SessionEntity $session + */ + public function __construct(SessionEntity $session) + { + $this->session = $session; + } + + /** + * The name of the event + * + * @return string + */ + public function getName() + { + return 'session.owner'; + } + + /** + * Return session + * + * @return \League\OAuth2\Server\Entity\SessionEntity + */ + public function getSession() + { + return $this->session; + } +} diff --git a/src/Event/UserAuthenticationFailedEvent.php b/src/Event/UserAuthenticationFailedEvent.php new file mode 100644 index 0000000..4cd8c4c --- /dev/null +++ b/src/Event/UserAuthenticationFailedEvent.php @@ -0,0 +1,55 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Event; + +use League\Event\AbstractEvent; +use Symfony\Component\HttpFoundation\Request; + +class UserAuthenticationFailedEvent extends AbstractEvent +{ + /** + * Request + * + * @var \Symfony\Component\HttpFoundation\Request + */ + private $request; + + /** + * Init the event with a request + * + * @param \Symfony\Component\HttpFoundation\Request $request + */ + public function __construct(Request $request) + { + $this->request = $request; + } + + /** + * The name of the event + * + * @return string + */ + public function getName() + { + return 'error.auth.user'; + } + + /** + * Return request + * + * @return \Symfony\Component\HttpFoundation\Request + */ + public function getRequest() + { + return $this->request; + } +} diff --git a/src/Exception/AccessDeniedException.php b/src/Exception/AccessDeniedException.php new file mode 100644 index 0000000..e5d84b6 --- /dev/null +++ b/src/Exception/AccessDeniedException.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class AccessDeniedException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 401; + + /** + * {@inheritdoc} + */ + public $errorType = 'access_denied'; + + /** + * {@inheritdoc} + */ + public function __construct() + { + parent::__construct('The resource owner or authorization server denied the request.'); + } +} diff --git a/src/Exception/InvalidClientException.php b/src/Exception/InvalidClientException.php new file mode 100644 index 0000000..ba01d27 --- /dev/null +++ b/src/Exception/InvalidClientException.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class InvalidClientException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 401; + + /** + * {@inheritdoc} + */ + public $errorType = 'invalid_client'; + + /** + * {@inheritdoc} + */ + public function __construct() + { + parent::__construct('Client authentication failed.'); + } +} diff --git a/src/Exception/InvalidCredentialsException.php b/src/Exception/InvalidCredentialsException.php new file mode 100644 index 0000000..40c4ce7 --- /dev/null +++ b/src/Exception/InvalidCredentialsException.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class InvalidCredentialsException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 401; + + /** + * {@inheritdoc} + */ + public $errorType = 'invalid_credentials'; + + /** + * {@inheritdoc} + */ + public function __construct() + { + parent::__construct('The user credentials were incorrect.'); + } +} diff --git a/src/Exception/InvalidGrantException.php b/src/Exception/InvalidGrantException.php new file mode 100644 index 0000000..4027a21 --- /dev/null +++ b/src/Exception/InvalidGrantException.php @@ -0,0 +1,43 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class InvalidGrantException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'invalid_grant'; + + /** + * {@inheritdoc} + */ + + public function __construct($parameter) + { + $this->parameter = $parameter; + parent::__construct( + sprintf( + 'The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client. Check the "%s" parameter.', + $parameter + ) + ); + } +} diff --git a/src/Exception/InvalidRefreshException.php b/src/Exception/InvalidRefreshException.php new file mode 100644 index 0000000..5ca3d92 --- /dev/null +++ b/src/Exception/InvalidRefreshException.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class InvalidRefreshException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'invalid_request'; + + /** + * {@inheritdoc} + */ + public function __construct() + { + parent::__construct('The refresh token is invalid.'); + } +} diff --git a/src/Exception/InvalidRequestException.php b/src/Exception/InvalidRequestException.php new file mode 100644 index 0000000..3a68293 --- /dev/null +++ b/src/Exception/InvalidRequestException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class InvalidRequestException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'invalid_request'; + + /** + * {@inheritdoc} + */ + + public function __construct($parameter, $redirectUri = null) + { + $this->parameter = $parameter; + parent::__construct( + sprintf( + 'The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "%s" parameter.', + $parameter + ) + ); + + $this->redirectUri = $redirectUri; + } +} diff --git a/src/Exception/InvalidScopeException.php b/src/Exception/InvalidScopeException.php new file mode 100644 index 0000000..e70cd69 --- /dev/null +++ b/src/Exception/InvalidScopeException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class InvalidScopeException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'invalid_scope'; + + /** + * {@inheritdoc} + */ + + public function __construct($parameter, $redirectUri = null) + { + $this->parameter = $parameter; + parent::__construct( + sprintf( + 'The requested scope is invalid, unknown, or malformed. Check the "%s" scope.', + $parameter + ) + ); + + $this->redirectUri = $redirectUri; + } +} diff --git a/src/Exception/OAuthException.php b/src/Exception/OAuthException.php new file mode 100644 index 0000000..2560d0e --- /dev/null +++ b/src/Exception/OAuthException.php @@ -0,0 +1,145 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +use League\OAuth2\Server\Util\RedirectUri; +use Symfony\Component\HttpFoundation\Request; + +/** + * Exception class + */ +class OAuthException extends \Exception +{ + /** + * The HTTP status code for this exception that should be sent in the response + */ + public $httpStatusCode = 400; + + /** + * Redirect URI if the server should redirect back to the client + * + * @var string|null + */ + public $redirectUri = null; + + /** + * The exception type + */ + public $errorType = ''; + + /** + * Parameter eventually passed to Exception + */ + public $parameter = ''; + + /** + * Throw a new exception + * + * @param string $msg Exception Message + */ + public function __construct($msg = 'An error occured') + { + parent::__construct($msg); + } + + /** + * Should the server redirect back to the client? + * + * @return bool + */ + public function shouldRedirect() + { + return is_null($this->redirectUri) ? false : true; + } + + /** + * Return redirect URI if set + * + * @return string|null + */ + public function getRedirectUri() + { + return RedirectUri::make( + $this->redirectUri, + [ + 'error' => $this->errorType, + 'message' => $this->getMessage(), + ] + ); + } + + /** + * Return parameter if set + * + * @return string + */ + public function getParameter() + { + return $this->parameter; + } + + /** + * Get all headers that have to be send with the error response + * + * @return array Array with header values + */ + public function getHttpHeaders() + { + $headers = []; + switch ($this->httpStatusCode) { + case 401: + $headers[] = 'HTTP/1.1 401 Unauthorized'; + break; + case 500: + $headers[] = 'HTTP/1.1 500 Internal Server Error'; + break; + case 501: + $headers[] = 'HTTP/1.1 501 Not Implemented'; + break; + case 400: + default: + $headers[] = 'HTTP/1.1 400 Bad Request'; + break; + } + + // Add "WWW-Authenticate" header + // + // RFC 6749, section 5.2.: + // "If the client attempted to authenticate via the 'Authorization' + // request header field, the authorization server MUST + // respond with an HTTP 401 (Unauthorized) status code and + // include the "WWW-Authenticate" response header field + // matching the authentication scheme used by the client. + // @codeCoverageIgnoreStart + if ($this->errorType === 'invalid_client') { + $authScheme = null; + $request = new Request(); + if ($request->getUser() !== null) { + $authScheme = 'Basic'; + } else { + $authHeader = $request->headers->get('Authorization'); + if ($authHeader !== null) { + if (strpos($authHeader, 'Bearer') === 0) { + $authScheme = 'Bearer'; + } elseif (strpos($authHeader, 'Basic') === 0) { + $authScheme = 'Basic'; + } + } + } + if ($authScheme !== null) { + $headers[] = 'WWW-Authenticate: '.$authScheme.' realm=""'; + } + } + // @codeCoverageIgnoreEnd + return $headers; + } +} diff --git a/src/Exception/ServerErrorException.php b/src/Exception/ServerErrorException.php new file mode 100644 index 0000000..70e9532 --- /dev/null +++ b/src/Exception/ServerErrorException.php @@ -0,0 +1,39 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class ServerErrorException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 500; + + /** + * {@inheritdoc} + */ + public $errorType = 'server_error'; + + /** + * {@inheritdoc} + */ + public function __construct($parameter = null) + { + $this->parameter = $parameter; + $parameter = is_null($parameter) ? 'The authorization server encountered an unexpected condition which prevented it from fulfilling the request.' : $parameter; + parent::__construct($parameter); + + } +} diff --git a/src/Exception/UnauthorizedClientException.php b/src/Exception/UnauthorizedClientException.php new file mode 100644 index 0000000..fd1f18c --- /dev/null +++ b/src/Exception/UnauthorizedClientException.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class UnauthorizedClientException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'unauthorized_client'; + + /** + * {@inheritdoc} + */ + public function __construct() + { + parent::__construct('The client is not authorized to request an access token using this method.'); + } +} diff --git a/src/Exception/UnsupportedGrantTypeException.php b/src/Exception/UnsupportedGrantTypeException.php new file mode 100644 index 0000000..b0a33ce --- /dev/null +++ b/src/Exception/UnsupportedGrantTypeException.php @@ -0,0 +1,43 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class UnsupportedGrantTypeException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'unsupported_grant_type'; + + /** + * {@inheritdoc} + */ + + public function __construct($parameter) + { + $this->parameter = $parameter; + parent::__construct( + sprintf( + 'The authorization grant type "%s" is not supported by the authorization server.', + $parameter + ) + ); + } +} diff --git a/src/Exception/UnsupportedResponseTypeException.php b/src/Exception/UnsupportedResponseTypeException.php new file mode 100644 index 0000000..663326d --- /dev/null +++ b/src/Exception/UnsupportedResponseTypeException.php @@ -0,0 +1,38 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Exception; + +/** + * Exception class + */ +class UnsupportedResponseTypeException extends OAuthException +{ + /** + * {@inheritdoc} + */ + public $httpStatusCode = 400; + + /** + * {@inheritdoc} + */ + public $errorType = 'unsupported_response_type'; + + /** + * {@inheritdoc} + */ + public function __construct($parameter, $redirectUri = null) + { + $this->parameter = $parameter; + parent::__construct('The authorization server does not support obtaining an access token using this method.'); + $this->redirectUri = $redirectUri; + } +} diff --git a/src/Grant/AbstractGrant.php b/src/Grant/AbstractGrant.php new file mode 100644 index 0000000..fd5cb52 --- /dev/null +++ b/src/Grant/AbstractGrant.php @@ -0,0 +1,197 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Grant; + +use League\OAuth2\Server\AuthorizationServer; +use League\OAuth2\Server\Entity\ClientEntity; +use League\OAuth2\Server\Entity\ScopeEntity; +use League\OAuth2\Server\Exception; + +/** + * Abstract grant class + */ +abstract class AbstractGrant implements GrantTypeInterface +{ + /** + * Grant identifier + * + * @var string + */ + protected $identifier = ''; + + /** + * Response type + * + * @var string + */ + protected $responseType; + + /** + * Callback to authenticate a user's name and password + * + * @var callable + */ + protected $callback; + + /** + * AuthServer instance + * + * @var \League\OAuth2\Server\AuthorizationServer + */ + protected $server; + + /** + * Access token expires in override + * + * @var int + */ + protected $accessTokenTTL; + + /** + * {@inheritdoc} + */ + public function getIdentifier() + { + return $this->identifier; + } + + /** + * {@inheritdoc} + */ + public function setIdentifier($identifier) + { + $this->identifier = $identifier; + + return $this; + } + + /** + * {@inheritdoc} + */ + public function getResponseType() + { + return $this->responseType; + } + + /** + * Get the TTL for an access token + * + * @return int The TTL + */ + public function getAccessTokenTTL() + { + if ($this->accessTokenTTL) { + return $this->accessTokenTTL; + } + + return $this->server->getAccessTokenTTL(); + } + + /** + * Override the default access token expire time + * + * @param int $accessTokenTTL + * + * @return self + */ + public function setAccessTokenTTL($accessTokenTTL) + { + $this->accessTokenTTL = $accessTokenTTL; + + return $this; + } + + /** + * {@inheritdoc} + */ + public function setAuthorizationServer(AuthorizationServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * Given a list of scopes, validate them and return an array of Scope entities + * + * @param string $scopeParam A string of scopes (e.g. "profile email birthday") + * @param \League\OAuth2\Server\Entity\ClientEntity $client Client entity + * @param string|null $redirectUri The redirect URI to return the user to + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] + * + * @throws \League\OAuth2\Server\Exception\InvalidScopeException If scope is invalid, or no scopes passed when required + * @throws + */ + public function validateScopes($scopeParam = '', ClientEntity $client, $redirectUri = null) + { + $scopesList = explode($this->server->getScopeDelimiter(), $scopeParam); + + for ($i = 0; $i < count($scopesList); $i++) { + $scopesList[$i] = trim($scopesList[$i]); + if ($scopesList[$i] === '') { + unset($scopesList[$i]); // Remove any junk scopes + } + } + + if ( + $this->server->scopeParamRequired() === true + && $this->server->getDefaultScope() === null + && count($scopesList) === 0 + ) { + throw new Exception\InvalidRequestException('scope'); + } elseif (count($scopesList) === 0 && $this->server->getDefaultScope() !== null) { + if (is_array($this->server->getDefaultScope())) { + $scopesList = $this->server->getDefaultScope(); + } else { + $scopesList = [0 => $this->server->getDefaultScope()]; + } + } + + $scopes = []; + + foreach ($scopesList as $scopeItem) { + $scope = $this->server->getScopeStorage()->get( + $scopeItem, + $this->getIdentifier(), + $client->getId() + ); + + if (($scope instanceof ScopeEntity) === false) { + throw new Exception\InvalidScopeException($scopeItem, $redirectUri); + } + + $scopes[$scope->getId()] = $scope; + } + + return $scopes; + } + + /** + * Format the local scopes array + * + * @param \League\OAuth2\Server\Entity\ScopeEntity[] + * + * @return array + */ + protected function formatScopes($unformated = []) + { + $scopes = []; + foreach ($unformated as $scope) { + if ($scope instanceof ScopeEntity) { + $scopes[$scope->getId()] = $scope; + } + } + + return $scopes; + } +} diff --git a/src/Grant/AuthCodeGrant.php b/src/Grant/AuthCodeGrant.php new file mode 100644 index 0000000..943a3b5 --- /dev/null +++ b/src/Grant/AuthCodeGrant.php @@ -0,0 +1,303 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Grant; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Entity\AuthCodeEntity; +use League\OAuth2\Server\Entity\ClientEntity; +use League\OAuth2\Server\Entity\RefreshTokenEntity; +use League\OAuth2\Server\Entity\SessionEntity; +use League\OAuth2\Server\Event; +use League\OAuth2\Server\Exception; +use League\OAuth2\Server\Util\SecureKey; + +/** + * Auth code grant class + */ +class AuthCodeGrant extends AbstractGrant +{ + /** + * Grant identifier + * + * @var string + */ + protected $identifier = 'authorization_code'; + + /** + * Response type + * + * @var string + */ + protected $responseType = 'code'; + + /** + * AuthServer instance + * + * @var \League\OAuth2\Server\AuthorizationServer + */ + protected $server = null; + + /** + * Access token expires in override + * + * @var int + */ + protected $accessTokenTTL = null; + + /** + * The TTL of the auth token + * + * @var integer + */ + protected $authTokenTTL = 600; + + /** + * Whether to require the client secret when + * completing the flow. + * + * @var boolean + */ + protected $requireClientSecret = true; + + /** + * Override the default access token expire time + * + * @param int $authTokenTTL + * + * @return void + */ + public function setAuthTokenTTL($authTokenTTL) + { + $this->authTokenTTL = $authTokenTTL; + } + + /** + * + * @param bool $required True to require client secret during access + * token request. False if not. Default = true + */ + public function setRequireClientSecret($required) + { + $this->requireClientSecret = $required; + } + + /** + * True if client secret is required during + * access token request. False if it isn't. + * + * @return bool + */ + public function shouldRequireClientSecret() + { + return $this->requireClientSecret; + } + + /** + * Check authorize parameters + * + * @return array Authorize request parameters + * + * @throws + */ + public function checkAuthorizeParams() + { + // Get required params + $clientId = $this->server->getRequest()->query->get('client_id', null); + if (is_null($clientId)) { + throw new Exception\InvalidRequestException('client_id'); + } + + $redirectUri = $this->server->getRequest()->query->get('redirect_uri', null); + if (is_null($redirectUri)) { + throw new Exception\InvalidRequestException('redirect_uri'); + } + + // Validate client ID and redirect URI + $client = $this->server->getClientStorage()->get( + $clientId, + null, + $redirectUri, + $this->getIdentifier() + ); + + if (($client instanceof ClientEntity) === false) { + $this->server->getEventEmitter()->emit(new Event\ClientAuthenticationFailedEvent($this->server->getRequest())); + throw new Exception\InvalidClientException(); + } + + $state = $this->server->getRequest()->query->get('state', null); + if ($this->server->stateParamRequired() === true && is_null($state)) { + throw new Exception\InvalidRequestException('state', $redirectUri); + } + + $responseType = $this->server->getRequest()->query->get('response_type', null); + if (is_null($responseType)) { + throw new Exception\InvalidRequestException('response_type', $redirectUri); + } + + // Ensure response type is one that is recognised + if (!in_array($responseType, $this->server->getResponseTypes())) { + throw new Exception\UnsupportedResponseTypeException($responseType, $redirectUri); + } + + // Validate any scopes that are in the request + $scopeParam = $this->server->getRequest()->query->get('scope', ''); + $scopes = $this->validateScopes($scopeParam, $client, $redirectUri); + + return [ + 'client' => $client, + 'redirect_uri' => $redirectUri, + 'state' => $state, + 'response_type' => $responseType, + 'scopes' => $scopes + ]; + } + + /** + * Parse a new authorize request + * + * @param string $type The session owner's type + * @param string $typeId The session owner's ID + * @param array $authParams The authorize request $_GET parameters + * + * @return string An authorisation code + */ + public function newAuthorizeRequest($type, $typeId, $authParams = []) + { + // Create a new session + $session = new SessionEntity($this->server); + $session->setOwner($type, $typeId); + $session->associateClient($authParams['client']); + + // Create a new auth code + $authCode = new AuthCodeEntity($this->server); + $authCode->setId(SecureKey::generate()); + $authCode->setRedirectUri($authParams['redirect_uri']); + $authCode->setExpireTime(time() + $this->authTokenTTL); + + foreach ($authParams['scopes'] as $scope) { + $authCode->associateScope($scope); + $session->associateScope($scope); + } + + $session->save(); + $authCode->setSession($session); + $authCode->save(); + + return $authCode->generateRedirectUri($authParams['state']); + } + + /** + * Complete the auth code grant + * + * @return array + * + * @throws + */ + public function completeFlow() + { + // Get the required params + $clientId = $this->server->getRequest()->request->get('client_id', $this->server->getRequest()->getUser()); + if (is_null($clientId)) { + throw new Exception\InvalidRequestException('client_id'); + } + + $clientSecret = $this->server->getRequest()->request->get('client_secret', + $this->server->getRequest()->getPassword()); + if ($this->shouldRequireClientSecret() && is_null($clientSecret)) { + throw new Exception\InvalidRequestException('client_secret'); + } + + $redirectUri = $this->server->getRequest()->request->get('redirect_uri', null); + if (is_null($redirectUri)) { + throw new Exception\InvalidRequestException('redirect_uri'); + } + + // Validate client ID and client secret + $client = $this->server->getClientStorage()->get( + $clientId, + $clientSecret, + $redirectUri, + $this->getIdentifier() + ); + + if (($client instanceof ClientEntity) === false) { + $this->server->getEventEmitter()->emit(new Event\ClientAuthenticationFailedEvent($this->server->getRequest())); + throw new Exception\InvalidClientException(); + } + + // Validate the auth code + $authCode = $this->server->getRequest()->request->get('code', null); + if (is_null($authCode)) { + throw new Exception\InvalidRequestException('code'); + } + + $code = $this->server->getAuthCodeStorage()->get($authCode); + if (($code instanceof AuthCodeEntity) === false) { + throw new Exception\InvalidRequestException('code'); + } + + // Ensure the auth code hasn't expired + if ($code->isExpired() === true) { + throw new Exception\InvalidRequestException('code'); + } + + // Check redirect URI presented matches redirect URI originally used in authorize request + if ($code->getRedirectUri() !== $redirectUri) { + throw new Exception\InvalidRequestException('redirect_uri'); + } + + $session = $code->getSession(); + $session->associateClient($client); + + $authCodeScopes = $code->getScopes(); + + // Generate the access token + $accessToken = new AccessTokenEntity($this->server); + $accessToken->setId(SecureKey::generate()); + $accessToken->setExpireTime($this->getAccessTokenTTL() + time()); + + foreach ($authCodeScopes as $authCodeScope) { + $session->associateScope($authCodeScope); + } + + foreach ($session->getScopes() as $scope) { + $accessToken->associateScope($scope); + } + + $this->server->getTokenType()->setSession($session); + $this->server->getTokenType()->setParam('access_token', $accessToken->getId()); + $this->server->getTokenType()->setParam('expires_in', $this->getAccessTokenTTL()); + + // Associate a refresh token if set + if ($this->server->hasGrantType('refresh_token')) { + $refreshToken = new RefreshTokenEntity($this->server); + $refreshToken->setId(SecureKey::generate()); + $refreshToken->setExpireTime($this->server->getGrantType('refresh_token')->getRefreshTokenTTL() + time()); + $this->server->getTokenType()->setParam('refresh_token', $refreshToken->getId()); + } + + // Expire the auth code + $code->expire(); + + // Save all the things + $accessToken->setSession($session); + $accessToken->save(); + + if (isset($refreshToken) && $this->server->hasGrantType('refresh_token')) { + $refreshToken->setAccessToken($accessToken); + $refreshToken->save(); + } + + return $this->server->getTokenType()->generateResponse(); + } +} \ No newline at end of file diff --git a/src/Grant/ClientCredentialsGrant.php b/src/Grant/ClientCredentialsGrant.php new file mode 100644 index 0000000..e219c63 --- /dev/null +++ b/src/Grant/ClientCredentialsGrant.php @@ -0,0 +1,122 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Grant; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Entity\ClientEntity; +use League\OAuth2\Server\Entity\SessionEntity; +use League\OAuth2\Server\Event; +use League\OAuth2\Server\Exception; +use League\OAuth2\Server\Util\SecureKey; + +/** + * Client credentials grant class + */ +class ClientCredentialsGrant extends AbstractGrant +{ + /** + * Grant identifier + * + * @var string + */ + protected $identifier = 'client_credentials'; + + /** + * Response type + * + * @var string + */ + protected $responseType = null; + + /** + * AuthServer instance + * + * @var \League\OAuth2\Server\AuthorizationServer + */ + protected $server = null; + + /** + * Access token expires in override + * + * @var int + */ + protected $accessTokenTTL = null; + + /** + * Complete the client credentials grant + * + * @return array + * + * @throws + */ + public function completeFlow() + { + // Get the required params + $clientId = $this->server->getRequest()->request->get('client_id', $this->server->getRequest()->getUser()); + if (is_null($clientId)) { + throw new Exception\InvalidRequestException('client_id'); + } + + $clientSecret = $this->server->getRequest()->request->get('client_secret', + $this->server->getRequest()->getPassword()); + if (is_null($clientSecret)) { + throw new Exception\InvalidRequestException('client_secret'); + } + + // Validate client ID and client secret + $client = $this->server->getClientStorage()->get( + $clientId, + $clientSecret, + null, + $this->getIdentifier() + ); + + if (($client instanceof ClientEntity) === false) { + $this->server->getEventEmitter()->emit(new Event\ClientAuthenticationFailedEvent($this->server->getRequest())); + throw new Exception\InvalidClientException(); + } + + // Validate any scopes that are in the request + $scopeParam = $this->server->getRequest()->request->get('scope', ''); + $scopes = $this->validateScopes($scopeParam, $client); + + // Create a new session + $session = new SessionEntity($this->server); + $session->setOwner('client', $client->getId()); + $session->associateClient($client); + + // Generate an access token + $accessToken = new AccessTokenEntity($this->server); + $accessToken->setId(SecureKey::generate()); + $accessToken->setExpireTime($this->getAccessTokenTTL() + time()); + + // Associate scopes with the session and access token + foreach ($scopes as $scope) { + $session->associateScope($scope); + } + + foreach ($session->getScopes() as $scope) { + $accessToken->associateScope($scope); + } + + // Save everything + $session->save(); + $accessToken->setSession($session); + $accessToken->save(); + + $this->server->getTokenType()->setSession($session); + $this->server->getTokenType()->setParam('access_token', $accessToken->getId()); + $this->server->getTokenType()->setParam('expires_in', $this->getAccessTokenTTL()); + + return $this->server->getTokenType()->generateResponse(); + } +} diff --git a/src/Grant/GrantTypeInterface.php b/src/Grant/GrantTypeInterface.php new file mode 100644 index 0000000..a946865 --- /dev/null +++ b/src/Grant/GrantTypeInterface.php @@ -0,0 +1,59 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Grant; + +use League\OAuth2\Server\AuthorizationServer; + +/** + * Grant type interface + */ +interface GrantTypeInterface +{ + /** + * Return the identifier + * + * @return string + */ + public function getIdentifier(); + + /** + * Return the identifier + * + * @param string $identifier + * + * @return self + */ + public function setIdentifier($identifier); + + /** + * Return the response type + * + * @return string + */ + public function getResponseType(); + + /** + * Inject the authorization server into the grant + * + * @param \League\OAuth2\Server\AuthorizationServer $server The authorization server instance + * + * @return self + */ + public function setAuthorizationServer(AuthorizationServer $server); + + /** + * Complete the grant flow + * + * @return array + */ + public function completeFlow(); +} diff --git a/src/Grant/PasswordGrant.php b/src/Grant/PasswordGrant.php new file mode 100644 index 0000000..7192108 --- /dev/null +++ b/src/Grant/PasswordGrant.php @@ -0,0 +1,182 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Grant; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Entity\ClientEntity; +use League\OAuth2\Server\Entity\RefreshTokenEntity; +use League\OAuth2\Server\Entity\SessionEntity; +use League\OAuth2\Server\Event; +use League\OAuth2\Server\Exception; +use League\OAuth2\Server\Util\SecureKey; + +/** + * Password grant class + */ +class PasswordGrant extends AbstractGrant +{ + /** + * Grant identifier + * + * @var string + */ + protected $identifier = 'password'; + + /** + * Response type + * + * @var string + */ + protected $responseType; + + /** + * Callback to authenticate a user's name and password + * + * @var callable + */ + protected $callback; + + /** + * Access token expires in override + * + * @var int + */ + protected $accessTokenTTL; + + /** + * Set the callback to verify a user's username and password + * + * @param callable $callback The callback function + * + * @return void + */ + public function setVerifyCredentialsCallback(callable $callback) + { + $this->callback = $callback; + } + + /** + * Return the callback function + * + * @return callable + * + * @throws + */ + protected function getVerifyCredentialsCallback() + { + if (is_null($this->callback) || !is_callable($this->callback)) { + throw new Exception\ServerErrorException('Null or non-callable callback set on Password grant'); + } + + return $this->callback; + } + + /** + * Complete the password grant + * + * @return array + * + * @throws + */ + public function completeFlow() + { + // Get the required params + $clientId = $this->server->getRequest()->request->get('client_id', $this->server->getRequest()->getUser()); + if (is_null($clientId)) { + throw new Exception\InvalidRequestException('client_id'); + } + + $clientSecret = $this->server->getRequest()->request->get('client_secret', + $this->server->getRequest()->getPassword()); + if (is_null($clientSecret)) { + throw new Exception\InvalidRequestException('client_secret'); + } + + // Validate client ID and client secret + $client = $this->server->getClientStorage()->get( + $clientId, + $clientSecret, + null, + $this->getIdentifier() + ); + + if (($client instanceof ClientEntity) === false) { + $this->server->getEventEmitter()->emit(new Event\ClientAuthenticationFailedEvent($this->server->getRequest())); + throw new Exception\InvalidClientException(); + } + + $username = $this->server->getRequest()->request->get('username', null); + if (is_null($username)) { + throw new Exception\InvalidRequestException('username'); + } + + $password = $this->server->getRequest()->request->get('password', null); + if (is_null($password)) { + throw new Exception\InvalidRequestException('password'); + } + + // Check if user's username and password are correct + $userId = call_user_func($this->getVerifyCredentialsCallback(), $username, $password); + + if ($userId === false) { + $this->server->getEventEmitter()->emit(new Event\UserAuthenticationFailedEvent($this->server->getRequest())); + throw new Exception\InvalidCredentialsException(); + } + + // Validate any scopes that are in the request + $scopeParam = $this->server->getRequest()->request->get('scope', ''); + $scopes = $this->validateScopes($scopeParam, $client); + + // Create a new session + $session = new SessionEntity($this->server); + $session->setOwner('user', $userId); + $session->associateClient($client); + + // Generate an access token + $accessToken = new AccessTokenEntity($this->server); + $accessToken->setId(SecureKey::generate()); + $accessToken->setExpireTime($this->getAccessTokenTTL() + time()); + + // Associate scopes with the session and access token + foreach ($scopes as $scope) { + $session->associateScope($scope); + } + + foreach ($session->getScopes() as $scope) { + $accessToken->associateScope($scope); + } + + $this->server->getTokenType()->setSession($session); + $this->server->getTokenType()->setParam('access_token', $accessToken->getId()); + $this->server->getTokenType()->setParam('expires_in', $this->getAccessTokenTTL()); + + // Associate a refresh token if set + if ($this->server->hasGrantType('refresh_token')) { + $refreshToken = new RefreshTokenEntity($this->server); + $refreshToken->setId(SecureKey::generate()); + $refreshToken->setExpireTime($this->server->getGrantType('refresh_token')->getRefreshTokenTTL() + time()); + $this->server->getTokenType()->setParam('refresh_token', $refreshToken->getId()); + } + + // Save everything + $session->save(); + $accessToken->setSession($session); + $accessToken->save(); + + if ($this->server->hasGrantType('refresh_token')) { + $refreshToken->setAccessToken($accessToken); + $refreshToken->save(); + } + + return $this->server->getTokenType()->generateResponse(); + } +} diff --git a/src/Grant/RefreshTokenGrant.php b/src/Grant/RefreshTokenGrant.php new file mode 100644 index 0000000..d7fd881 --- /dev/null +++ b/src/Grant/RefreshTokenGrant.php @@ -0,0 +1,223 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Grant; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Entity\ClientEntity; +use League\OAuth2\Server\Entity\RefreshTokenEntity; +use League\OAuth2\Server\Event; +use League\OAuth2\Server\Exception; +use League\OAuth2\Server\Util\SecureKey; + +/** + * Refresh token grant + */ +class RefreshTokenGrant extends AbstractGrant +{ + /** + * {@inheritdoc} + */ + protected $identifier = 'refresh_token'; + + /** + * Refresh token TTL (default = 604800 | 1 week) + * + * @var integer + */ + protected $refreshTokenTTL = 604800; + + /** + * Rotate token (default = true) + * + * @var integer + */ + protected $refreshTokenRotate = true; + + /** + * Whether to require the client secret when + * completing the flow. + * + * @var boolean + */ + protected $requireClientSecret = true; + + /** + * Set the TTL of the refresh token + * + * @param int $refreshTokenTTL + * + * @return void + */ + public function setRefreshTokenTTL($refreshTokenTTL) + { + $this->refreshTokenTTL = $refreshTokenTTL; + } + + /** + * Get the TTL of the refresh token + * + * @return int + */ + public function getRefreshTokenTTL() + { + return $this->refreshTokenTTL; + } + + /** + * Set the rotation boolean of the refresh token + * @param bool $refreshTokenRotate + */ + public function setRefreshTokenRotation($refreshTokenRotate = true) + { + $this->refreshTokenRotate = $refreshTokenRotate; + } + + /** + * Get rotation boolean of the refresh token + * + * @return bool + */ + public function shouldRotateRefreshTokens() + { + return $this->refreshTokenRotate; + } + + /** + * + * @param bool $required True to require client secret during access + * token request. False if not. Default = true + */ + public function setRequireClientSecret($required) + { + $this->requireClientSecret = $required; + } + + /** + * True if client secret is required during + * access token request. False if it isn't. + * + * @return bool + */ + public function shouldRequireClientSecret() + { + return $this->requireClientSecret; + } + + + /** + * {@inheritdoc} + */ + public function completeFlow() + { + $clientId = $this->server->getRequest()->request->get('client_id', $this->server->getRequest()->getUser()); + if (is_null($clientId)) { + throw new Exception\InvalidRequestException('client_id'); + } + + $clientSecret = $this->server->getRequest()->request->get('client_secret', + $this->server->getRequest()->getPassword()); + if ($this->shouldRequireClientSecret() && is_null($clientSecret)) { + throw new Exception\InvalidRequestException('client_secret'); + } + + // Validate client ID and client secret + $client = $this->server->getClientStorage()->get( + $clientId, + $clientSecret, + null, + $this->getIdentifier() + ); + + if (($client instanceof ClientEntity) === false) { + $this->server->getEventEmitter()->emit(new Event\ClientAuthenticationFailedEvent($this->server->getRequest())); + throw new Exception\InvalidClientException(); + } + + $oldRefreshTokenParam = $this->server->getRequest()->request->get('refresh_token', null); + if ($oldRefreshTokenParam === null) { + throw new Exception\InvalidRequestException('refresh_token'); + } + + // Validate refresh token + $oldRefreshToken = $this->server->getRefreshTokenStorage()->get($oldRefreshTokenParam); + + if (($oldRefreshToken instanceof RefreshTokenEntity) === false) { + throw new Exception\InvalidRefreshException(); + } + + // Ensure the old refresh token hasn't expired + if ($oldRefreshToken->isExpired() === true) { + throw new Exception\InvalidRefreshException(); + } + + $oldAccessToken = $oldRefreshToken->getAccessToken(); + + // Get the scopes for the original session + $session = $oldAccessToken->getSession(); + $scopes = $this->formatScopes($session->getScopes()); + + // Get and validate any requested scopes + $requestedScopesString = $this->server->getRequest()->request->get('scope', ''); + $requestedScopes = $this->validateScopes($requestedScopesString, $client); + + // If no new scopes are requested then give the access token the original session scopes + if (count($requestedScopes) === 0) { + $newScopes = $scopes; + } else { + // The OAuth spec says that a refreshed access token can have the original scopes or fewer so ensure + // the request doesn't include any new scopes + foreach ($requestedScopes as $requestedScope) { + if (!isset($scopes[$requestedScope->getId()])) { + throw new Exception\InvalidScopeException($requestedScope->getId()); + } + } + + $newScopes = $requestedScopes; + } + + // Generate a new access token and assign it the correct sessions + $newAccessToken = new AccessTokenEntity($this->server); + $newAccessToken->setId(SecureKey::generate()); + $newAccessToken->setExpireTime($this->getAccessTokenTTL() + time()); + $newAccessToken->setSession($session); + + foreach ($newScopes as $newScope) { + $newAccessToken->associateScope($newScope); + } + + // Expire the old token and save the new one + $oldAccessToken->expire(); + $newAccessToken->save(); + + $this->server->getTokenType()->setSession($session); + $this->server->getTokenType()->setParam('access_token', $newAccessToken->getId()); + $this->server->getTokenType()->setParam('expires_in', $this->getAccessTokenTTL()); + + if ($this->shouldRotateRefreshTokens()) { + // Expire the old refresh token + $oldRefreshToken->expire(); + + // Generate a new refresh token + $newRefreshToken = new RefreshTokenEntity($this->server); + $newRefreshToken->setId(SecureKey::generate()); + $newRefreshToken->setExpireTime($this->getRefreshTokenTTL() + time()); + $newRefreshToken->setAccessToken($newAccessToken); + $newRefreshToken->save(); + + $this->server->getTokenType()->setParam('refresh_token', $newRefreshToken->getId()); + } else { + $this->server->getTokenType()->setParam('refresh_token', $oldRefreshToken->getId()); + } + + return $this->server->getTokenType()->generateResponse(); + } +} \ No newline at end of file diff --git a/src/ResourceServer.php b/src/ResourceServer.php new file mode 100644 index 0000000..79ed993 --- /dev/null +++ b/src/ResourceServer.php @@ -0,0 +1,157 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Exception\AccessDeniedException; +use League\OAuth2\Server\Exception\InvalidRequestException; +use League\OAuth2\Server\Storage\AccessTokenInterface; +use League\OAuth2\Server\Storage\ClientInterface; +use League\OAuth2\Server\Storage\ScopeInterface; +use League\OAuth2\Server\Storage\SessionInterface; +use League\OAuth2\Server\TokenType\Bearer; +use League\OAuth2\Server\TokenType\MAC; + +/** + * OAuth 2.0 Resource Server + */ +class ResourceServer extends AbstractServer +{ + /** + * The access token + * + * @var \League\OAuth2\Server\Entity\AccessTokenEntity + */ + protected $accessToken; + + /** + * The query string key which is used by clients to present the access token (default: access_token) + * + * @var string + */ + protected $tokenKey = 'access_token'; + + /** + * Initialise the resource server + * + * @param \League\OAuth2\Server\Storage\SessionInterface $sessionStorage + * @param \League\OAuth2\Server\Storage\AccessTokenInterface $accessTokenStorage + * @param \League\OAuth2\Server\Storage\ClientInterface $clientStorage + * @param \League\OAuth2\Server\Storage\ScopeInterface $scopeStorage + * + * @return self + */ + public function __construct( + SessionInterface $sessionStorage, + AccessTokenInterface $accessTokenStorage, + ClientInterface $clientStorage, + ScopeInterface $scopeStorage + ) { + $this->setSessionStorage($sessionStorage); + $this->setAccessTokenStorage($accessTokenStorage); + $this->setClientStorage($clientStorage); + $this->setScopeStorage($scopeStorage); + + // Set Bearer as the default token type + $this->setTokenType(new Bearer()); + + parent::__construct(); + + return $this; + } + + /** + * Sets the query string key for the access token. + * + * @param string $key The new query string key + * + * @return self + */ + public function setIdKey($key) + { + $this->tokenKey = $key; + + return $this; + } + + /** + * Gets the access token + * + * @return \League\OAuth2\Server\Entity\AccessTokenEntity + */ + public function getAccessToken() + { + return $this->accessToken; + } + + /** + * Checks if the access token is valid or not + * + * @param bool $headerOnly Limit Access Token to Authorization header + * @param \League\OAuth2\Server\Entity\AccessTokenEntity|null $accessToken Access Token + * + * @throws \League\OAuth2\Server\Exception\AccessDeniedException + * @throws \League\OAuth2\Server\Exception\InvalidRequestException + * + * @return bool + */ + public function isValidRequest($headerOnly = true, $accessToken = null) + { + $accessTokenString = ($accessToken !== null) + ? $accessToken + : $this->determineAccessToken($headerOnly); + + // Set the access token + $this->accessToken = $this->getAccessTokenStorage()->get($accessTokenString); + + // Ensure the access token exists + if (!$this->accessToken instanceof AccessTokenEntity) { + throw new AccessDeniedException(); + } + + // Check the access token hasn't expired + // Ensure the auth code hasn't expired + if ($this->accessToken->isExpired() === true) { + throw new AccessDeniedException(); + } + + return true; + } + + /** + * Reads in the access token from the headers + * + * @param bool $headerOnly Limit Access Token to Authorization header + * + * @throws \League\OAuth2\Server\Exception\InvalidRequestException Thrown if there is no access token presented + * + * @return string + */ + public function determineAccessToken($headerOnly = false) + { + $authHeader = $this->getRequest()->headers->get('Authorization'); + + if (!empty($authHeader)) { + $accessToken = $this->getTokenType()->determineAccessTokenInHeader($this->getRequest()); + } elseif ($headerOnly === false && (! $this->getTokenType() instanceof MAC)) { + $accessToken = ($this->getRequest()->server->get('REQUEST_METHOD') === 'GET') + ? $this->getRequest()->query->get($this->tokenKey) + : $this->getRequest()->request->get($this->tokenKey); + } + + if (empty($accessToken)) { + throw new InvalidRequestException('access token'); + } + + return $accessToken; + } +} diff --git a/src/Storage/AbstractStorage.php b/src/Storage/AbstractStorage.php new file mode 100644 index 0000000..2bfb560 --- /dev/null +++ b/src/Storage/AbstractStorage.php @@ -0,0 +1,51 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\AbstractServer; + +/** + * Abstract storage class + */ +abstract class AbstractStorage implements StorageInterface +{ + /** + * Server + * + * @var \League\OAuth2\Server\AbstractServer $server + */ + protected $server; + + /** + * Set the server + * + * @param \League\OAuth2\Server\AbstractServer $server + * + * @return self + */ + public function setServer(AbstractServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * Return the server + * + * @return \League\OAuth2\Server\AbstractServer + */ + protected function getServer() + { + return $this->server; + } +} diff --git a/src/Storage/AccessTokenInterface.php b/src/Storage/AccessTokenInterface.php new file mode 100644 index 0000000..129679d --- /dev/null +++ b/src/Storage/AccessTokenInterface.php @@ -0,0 +1,69 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Entity\ScopeEntity; + +/** + * Access token interface + */ +interface AccessTokenInterface extends StorageInterface +{ + /** + * Get an instance of Entity\AccessTokenEntity + * + * @param string $token The access token + * + * @return \League\OAuth2\Server\Entity\AccessTokenEntity | null + */ + public function get($token); + + /** + * Get the scopes for an access token + * + * @param \League\OAuth2\Server\Entity\AccessTokenEntity $token The access token + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] Array of \League\OAuth2\Server\Entity\ScopeEntity + */ + public function getScopes(AccessTokenEntity $token); + + /** + * Creates a new access token + * + * @param string $token The access token + * @param integer $expireTime The expire time expressed as a unix timestamp + * @param string|integer $sessionId The session ID + * + * @return void + */ + public function create($token, $expireTime, $sessionId); + + /** + * Associate a scope with an acess token + * + * @param \League\OAuth2\Server\Entity\AccessTokenEntity $token The access token + * @param \League\OAuth2\Server\Entity\ScopeEntity $scope The scope + * + * @return void + */ + public function associateScope(AccessTokenEntity $token, ScopeEntity $scope); + + /** + * Delete an access token + * + * @param \League\OAuth2\Server\Entity\AccessTokenEntity $token The access token to delete + * + * @return void + */ + public function delete(AccessTokenEntity $token); +} diff --git a/src/Storage/AuthCodeInterface.php b/src/Storage/AuthCodeInterface.php new file mode 100644 index 0000000..d451d2e --- /dev/null +++ b/src/Storage/AuthCodeInterface.php @@ -0,0 +1,70 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\Entity\AuthCodeEntity; +use League\OAuth2\Server\Entity\ScopeEntity; + +/** + * Auth code storage interface + */ +interface AuthCodeInterface extends StorageInterface +{ + /** + * Get the auth code + * + * @param string $code + * + * @return \League\OAuth2\Server\Entity\AuthCodeEntity | null + */ + public function get($code); + + /** + * Create an auth code. + * + * @param string $token The token ID + * @param integer $expireTime Token expire time + * @param integer $sessionId Session identifier + * @param string $redirectUri Client redirect uri + * + * @return void + */ + public function create($token, $expireTime, $sessionId, $redirectUri); + + /** + * Get the scopes for an access token + * + * @param \League\OAuth2\Server\Entity\AuthCodeEntity $token The auth code + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] Array of \League\OAuth2\Server\Entity\ScopeEntity + */ + public function getScopes(AuthCodeEntity $token); + + /** + * Associate a scope with an acess token + * + * @param \League\OAuth2\Server\Entity\AuthCodeEntity $token The auth code + * @param \League\OAuth2\Server\Entity\ScopeEntity $scope The scope + * + * @return void + */ + public function associateScope(AuthCodeEntity $token, ScopeEntity $scope); + + /** + * Delete an access token + * + * @param \League\OAuth2\Server\Entity\AuthCodeEntity $token The access token to delete + * + * @return void + */ + public function delete(AuthCodeEntity $token); +} diff --git a/src/Storage/ClientInterface.php b/src/Storage/ClientInterface.php new file mode 100644 index 0000000..e896831 --- /dev/null +++ b/src/Storage/ClientInterface.php @@ -0,0 +1,41 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\Entity\SessionEntity; + +/** + * Client storage interface + */ +interface ClientInterface extends StorageInterface +{ + /** + * Validate a client + * + * @param string $clientId The client's ID + * @param string $clientSecret The client's secret (default = "null") + * @param string $redirectUri The client's redirect URI (default = "null") + * @param string $grantType The grant type used (default = "null") + * + * @return \League\OAuth2\Server\Entity\ClientEntity | null + */ + public function get($clientId, $clientSecret = null, $redirectUri = null, $grantType = null); + + /** + * Get the client associated with a session + * + * @param \League\OAuth2\Server\Entity\SessionEntity $session The session + * + * @return \League\OAuth2\Server\Entity\ClientEntity | null + */ + public function getBySession(SessionEntity $session); +} diff --git a/src/Storage/MacTokenInterface.php b/src/Storage/MacTokenInterface.php new file mode 100644 index 0000000..ed5a063 --- /dev/null +++ b/src/Storage/MacTokenInterface.php @@ -0,0 +1,34 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + + +/** + * MacTokenInterface + */ +interface MacTokenInterface extends StorageInterface +{ + /** + * Create a MAC key linked to an access token + * @param string $macKey + * @param string $accessToken + * @return void + */ + public function create($macKey, $accessToken); + + /** + * Get a MAC key by access token + * @param string $accessToken + * @return string + */ + public function getByAccessToken($accessToken); +} diff --git a/src/Storage/RefreshTokenInterface.php b/src/Storage/RefreshTokenInterface.php new file mode 100644 index 0000000..e2f1995 --- /dev/null +++ b/src/Storage/RefreshTokenInterface.php @@ -0,0 +1,49 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\Entity\RefreshTokenEntity; + +/** + * Refresh token interface + */ +interface RefreshTokenInterface extends StorageInterface +{ + /** + * Return a new instance of \League\OAuth2\Server\Entity\RefreshTokenEntity + * + * @param string $token + * + * @return \League\OAuth2\Server\Entity\RefreshTokenEntity | null + */ + public function get($token); + + /** + * Create a new refresh token_name + * + * @param string $token + * @param integer $expireTime + * @param string $accessToken + * + * @return \League\OAuth2\Server\Entity\RefreshTokenEntity + */ + public function create($token, $expireTime, $accessToken); + + /** + * Delete the refresh token + * + * @param \League\OAuth2\Server\Entity\RefreshTokenEntity $token + * + * @return void + */ + public function delete(RefreshTokenEntity $token); +} diff --git a/src/Storage/ScopeInterface.php b/src/Storage/ScopeInterface.php new file mode 100644 index 0000000..1257a81 --- /dev/null +++ b/src/Storage/ScopeInterface.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +/** + * Scope interface + */ +interface ScopeInterface extends StorageInterface +{ + /** + * Return information about a scope + * + * @param string $scope The scope + * @param string $grantType The grant type used in the request (default = "null") + * @param string $clientId The client sending the request (default = "null") + * + * @return \League\OAuth2\Server\Entity\ScopeEntity | null + */ + public function get($scope, $grantType = null, $clientId = null); +} diff --git a/src/Storage/SessionInterface.php b/src/Storage/SessionInterface.php new file mode 100644 index 0000000..5cd95ee --- /dev/null +++ b/src/Storage/SessionInterface.php @@ -0,0 +1,81 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\Entity\AccessTokenEntity; +use League\OAuth2\Server\Entity\AuthCodeEntity; +use League\OAuth2\Server\Entity\ScopeEntity; +use League\OAuth2\Server\Entity\SessionEntity; + +/** + * Session storage interface + */ +interface SessionInterface extends StorageInterface +{ + /** + * Get a session from an access token + * + * @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessToken The access token + * + * @return \League\OAuth2\Server\Entity\SessionEntity | null + */ + public function getByAccessToken(AccessTokenEntity $accessToken); + + /** + * Get a session from an auth code + * + * @param \League\OAuth2\Server\Entity\AuthCodeEntity $authCode The auth code + * + * @return \League\OAuth2\Server\Entity\SessionEntity | null + */ + public function getByAuthCode(AuthCodeEntity $authCode); + + /** + * Get a session's scopes + * + * @param \League\OAuth2\Server\Entity\SessionEntity + * + * @return \League\OAuth2\Server\Entity\ScopeEntity[] Array of \League\OAuth2\Server\Entity\ScopeEntity + */ + public function getScopes(SessionEntity $session); + + /** + * Create a new session + * + * @param string $ownerType Session owner's type (user, client) + * @param string $ownerId Session owner's ID + * @param string $clientId Client ID + * @param string $clientRedirectUri Client redirect URI (default = null) + * + * @return integer The session's ID + */ + public function create($ownerType, $ownerId, $clientId, $clientRedirectUri = null); + + /** + * Associate a scope with a session + * + * @param \League\OAuth2\Server\Entity\SessionEntity $session The session + * @param \League\OAuth2\Server\Entity\ScopeEntity $scope The scope + * + * @return void + */ + public function associateScope(SessionEntity $session, ScopeEntity $scope); + + /** + * Delete a session + * + * @param \League\OAuth2\Server\Entity\SessionEntity $session The session to delete + * + * @return void + */ + public function delete(SessionEntity $session); +} diff --git a/src/Storage/StorageInterface.php b/src/Storage/StorageInterface.php new file mode 100644 index 0000000..ff9614b --- /dev/null +++ b/src/Storage/StorageInterface.php @@ -0,0 +1,27 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Storage; + +use League\OAuth2\Server\AbstractServer; + +/** + * Storage interface + */ +interface StorageInterface +{ + /** + * Set the server + * + * @param \League\OAuth2\Server\AbstractServer $server + */ + public function setServer(AbstractServer $server); +} diff --git a/src/TokenType/AbstractTokenType.php b/src/TokenType/AbstractTokenType.php new file mode 100644 index 0000000..adb8837 --- /dev/null +++ b/src/TokenType/AbstractTokenType.php @@ -0,0 +1,75 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\TokenType; + +use League\OAuth2\Server\AbstractServer; +use League\OAuth2\Server\Entity\SessionEntity; + +abstract class AbstractTokenType +{ + /** + * Response array + * + * @var array + */ + protected $response = []; + + /** + * Server + * + * @var \League\OAuth2\Server\AbstractServer $server + */ + protected $server; + + /** + * Server + * + * @var \League\OAuth2\Server\Entity\SessionEntity $session + */ + protected $session; + + /** + * {@inheritdoc} + */ + public function setServer(AbstractServer $server) + { + $this->server = $server; + + return $this; + } + + /** + * {@inheritdoc} + */ + public function setSession(SessionEntity $session) + { + $this->session = $session; + + return $this; + } + + /** + * {@inheritdoc} + */ + public function setParam($key, $value) + { + $this->response[$key] = $value; + } + + /** + * {@inheritdoc} + */ + public function getParam($key) + { + return isset($this->response[$key]) ? $this->response[$key] : null; + } +} diff --git a/src/TokenType/Bearer.php b/src/TokenType/Bearer.php new file mode 100644 index 0000000..950fce1 --- /dev/null +++ b/src/TokenType/Bearer.php @@ -0,0 +1,53 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\TokenType; + +use Symfony\Component\HttpFoundation\Request; + +class Bearer extends AbstractTokenType implements TokenTypeInterface +{ + /** + * {@inheritdoc} + */ + public function generateResponse() + { + $return = [ + 'access_token' => $this->getParam('access_token'), + 'token_type' => 'Bearer', + 'expires_in' => $this->getParam('expires_in'), + ]; + + if (!is_null($this->getParam('refresh_token'))) { + $return['refresh_token'] = $this->getParam('refresh_token'); + } + + return $return; + } + + /** + * {@inheritdoc} + */ + public function determineAccessTokenInHeader(Request $request) + { + if ($request->headers->has('Authorization') === false) { + return; + } + + $header = $request->headers->get('Authorization'); + + if (substr($header, 0, 7) !== 'Bearer ') { + return; + } + + return trim(substr($header, 7)); + } +} diff --git a/src/TokenType/MAC.php b/src/TokenType/MAC.php new file mode 100644 index 0000000..886b737 --- /dev/null +++ b/src/TokenType/MAC.php @@ -0,0 +1,156 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\TokenType; + +use League\OAuth2\Server\Util\SecureKey; +use Symfony\Component\HttpFoundation\ParameterBag; +use Symfony\Component\HttpFoundation\Request; + +/** + * MAC Token Type + */ +class MAC extends AbstractTokenType implements TokenTypeInterface +{ + /** + * {@inheritdoc} + */ + public function generateResponse() + { + $macKey = SecureKey::generate(); + $this->server->getMacStorage()->create($macKey, $this->getParam('access_token')); + + $response = [ + 'access_token' => $this->getParam('access_token'), + 'token_type' => 'mac', + 'expires_in' => $this->getParam('expires_in'), + 'mac_key' => $macKey, + 'mac_algorithm' => 'hmac-sha-256', + ]; + + if (!is_null($this->getParam('refresh_token'))) { + $response['refresh_token'] = $this->getParam('refresh_token'); + } + + return $response; + } + + /** + * {@inheritdoc} + */ + public function determineAccessTokenInHeader(Request $request) + { + if ($request->headers->has('Authorization') === false) { + return; + } + + $header = $request->headers->get('Authorization'); + + if (substr($header, 0, 4) !== 'MAC ') { + return; + } + + // Find all the parameters expressed in the header + $paramsRaw = explode(',', substr($header, 4)); + $params = new ParameterBag(); + + array_map(function ($param) use (&$params) { + $param = trim($param); + + preg_match_all('/([a-zA-Z]*)="([\w=\/+]*)"/', $param, $matches); + + // @codeCoverageIgnoreStart + if (count($matches) !== 3) { + return; + } + // @codeCoverageIgnoreEnd + + $key = reset($matches[1]); + $value = trim(reset($matches[2])); + + if (empty($value)) { + return; + } + + $params->set($key, $value); + }, $paramsRaw); + + // Validate parameters + if ($params->has('id') === false || $params->has('ts') === false || $params->has('nonce') === false || $params->has('mac') === false) { + return; + } + + if (abs($params->get('ts') - time()) > 300) { + return; + } + + $accessToken = $params->get('id'); + $timestamp = (int) $params->get('ts'); + $nonce = $params->get('nonce'); + $signature = $params->get('mac'); + + // Try to find the MAC key for the access token + $macKey = $this->server->getMacStorage()->getByAccessToken($accessToken); + + if ($macKey === null) { + return; + } + + // Calculate and compare the signature + $calculatedSignatureParts = [ + $timestamp, + $nonce, + strtoupper($request->getMethod()), + $request->getRequestUri(), + $request->getHost(), + $request->getPort(), + ]; + + if ($params->has('ext')) { + $calculatedSignatureParts[] = $params->get('ext'); + } + + $calculatedSignature = base64_encode( + hash_hmac( + 'sha256', + implode("\n", $calculatedSignatureParts), + $macKey, + true // raw_output: outputs raw binary data + ) + ); + + // Return the access token if the signature matches + return ($this->hash_equals($calculatedSignature, $signature)) ? $accessToken : null; + } + + /** + * Prevent timing attack + * @param string $knownString + * @param string $userString + * @return bool + */ + private function hash_equals($knownString, $userString) + { + if (function_exists('\hash_equals')) { + return \hash_equals($knownString, $userString); + } + if (strlen($knownString) !== strlen($userString)) { + return false; + } + $len = strlen($knownString); + $result = 0; + for ($i = 0; $i < $len; $i++) { + $result |= (ord($knownString[$i]) ^ ord($userString[$i])); + } + // They are only identical strings if $result is exactly 0... + return 0 === $result; + } +} diff --git a/src/TokenType/TokenTypeInterface.php b/src/TokenType/TokenTypeInterface.php new file mode 100644 index 0000000..17c2c1c --- /dev/null +++ b/src/TokenType/TokenTypeInterface.php @@ -0,0 +1,68 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\TokenType; + +use League\OAuth2\Server\AbstractServer; +use League\OAuth2\Server\Entity\SessionEntity; +use Symfony\Component\HttpFoundation\Request; + +interface TokenTypeInterface +{ + /** + * Generate a response + * + * @return array + */ + public function generateResponse(); + + /** + * Set the server + * + * @param \League\OAuth2\Server\AbstractServer $server + * + * @return self + */ + public function setServer(AbstractServer $server); + + /** + * Set a key/value response pair + * + * @param string $key + * @param mixed $value + */ + public function setParam($key, $value); + + /** + * Get a key from the response array + * + * @param string $key + * + * @return mixed + */ + public function getParam($key); + + /** + * @param \League\OAuth2\Server\Entity\SessionEntity $session + * + * @return self + */ + public function setSession(SessionEntity $session); + + /** + * Determine the access token in the authorization header + * + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return string + */ + public function determineAccessTokenInHeader(Request $request); +} diff --git a/src/Util/KeyAlgorithm/DefaultAlgorithm.php b/src/Util/KeyAlgorithm/DefaultAlgorithm.php new file mode 100644 index 0000000..70fecb1 --- /dev/null +++ b/src/Util/KeyAlgorithm/DefaultAlgorithm.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Util\KeyAlgorithm; + +class DefaultAlgorithm implements KeyAlgorithmInterface +{ + /** + * {@inheritdoc} + */ + public function generate($len = 40) + { + $stripped = ''; + do { + $bytes = openssl_random_pseudo_bytes($len, $strong); + + // We want to stop execution if the key fails because, well, that is bad. + if ($bytes === false || $strong === false) { + // @codeCoverageIgnoreStart + throw new \Exception('Error Generating Key'); + // @codeCoverageIgnoreEnd + } + $stripped .= str_replace(['/', '+', '='], '', base64_encode($bytes)); + } while (strlen($stripped) < $len); + + return substr($stripped, 0, $len); + } +} diff --git a/src/Util/KeyAlgorithm/KeyAlgorithmInterface.php b/src/Util/KeyAlgorithm/KeyAlgorithmInterface.php new file mode 100644 index 0000000..c1237f9 --- /dev/null +++ b/src/Util/KeyAlgorithm/KeyAlgorithmInterface.php @@ -0,0 +1,24 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Util\KeyAlgorithm; + +interface KeyAlgorithmInterface +{ + /** + * Generate a new unique code + * + * @param integer $len Length of the generated code + * + * @return string + */ + public function generate($len); +} diff --git a/src/Util/RedirectUri.php b/src/Util/RedirectUri.php new file mode 100644 index 0000000..848e854 --- /dev/null +++ b/src/Util/RedirectUri.php @@ -0,0 +1,34 @@ + + * @copyright Copyright (c) Alex Bilbie + * @license http://mit-license.org/ + * @link https://github.com/thephpleague/oauth2-server + */ + +namespace League\OAuth2\Server\Util; + +/** + * RedirectUri class + */ +class RedirectUri +{ + /** + * Generate a new redirect uri + * + * @param string $uri The base URI + * @param array $params The query string parameters + * @param string $queryDelimeter The query string delimeter (default: "?") + * + * @return string The updated URI + */ + public static function make($uri, $params = [], $queryDelimeter = '?') + { + $uri .= (strstr($uri, $queryDelimeter) === false) ? $queryDelimeter : '&'; + + return $uri.http_build_query($params); + } +} diff --git a/src/Util/SecureKey.php b/src/Util/SecureKey.php new file mode 100644 index 0000000..95ca56b --- /dev/null +++ b/src/Util/SecureKey.php @@ -0,0 +1,55 @@ + + * @copyright Copyright (c) 2013 PHP League of Extraordinary Packages + * @license http://mit-license.org/ + * @link http://github.com/php-loep/oauth2-server + */ + +namespace League\OAuth2\Server\Util; + +use League\OAuth2\Server\Util\KeyAlgorithm\DefaultAlgorithm; +use League\OAuth2\Server\Util\KeyAlgorithm\KeyAlgorithmInterface; + +/** + * SecureKey class + */ +class SecureKey +{ + protected static $algorithm; + + /** + * Generate a new unique code + * + * @param integer $len Length of the generated code + * + * @return string + */ + public static function generate($len = 40) + { + return self::getAlgorithm()->generate($len); + } + + /** + * @param KeyAlgorithmInterface $algorithm + */ + public static function setAlgorithm(KeyAlgorithmInterface $algorithm) + { + self::$algorithm = $algorithm; + } + + /** + * @return KeyAlgorithmInterface + */ + public static function getAlgorithm() + { + if (is_null(self::$algorithm)) { + self::$algorithm = new DefaultAlgorithm(); + } + + return self::$algorithm; + } +}