ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2025-01-09 05:23:53 +05:30
Code Issues Packages Projects Releases Wiki Activity

Updated docblocks

Browse Source
This commit is contained in:
Alex Bilbie 2013-02-13 19:59:08 +00:00
parent 246732153c
commit f818bdf40e
6 changed files with 144 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/OAuth2/Grant/RefreshToken.php
View File

@ -1,4 +1,13 @@
<?php <?php
/**
* OAuth 2.0 Refresh token grant
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
namespace OAuth2\Grant; namespace OAuth2\Grant;
@ -10,22 +19,47 @@ use OAuth2\Storage\SessionInterface;
use OAuth2\Storage\ClientInterface; use OAuth2\Storage\ClientInterface;
use OAuth2\Storage\ScopeInterface; use OAuth2\Storage\ScopeInterface;
/**
* Referesh token grant
*/
class RefreshToken implements GrantTypeInterface { class RefreshToken implements GrantTypeInterface {
/**
* Grant identifier
* @var string
*/
protected $identifier = 'refresh_token'; protected $identifier = 'refresh_token';
/**
* Response type
* @var string
*/
protected $responseType = null; protected $responseType = null;
/**
* Return the identifier
* @return string
*/
public function getIdentifier() public function getIdentifier()
{ {
return $this->identifier; return $this->identifier;
} }
/**
* Return the response type
* @return string
*/
public function getResponseType() public function getResponseType()
{ {
return $this->responseType; return $this->responseType;
} }
public function completeFlow($inputParams = null, $authParams = array()) /**
* Complete the refresh token grant
* @param null|array $inputParams
* @return array
*/
public function completeFlow($inputParams = null)
{ {
// Get the required params // Get the required params
$authParams = AuthServer::getParam(array('client_id', 'client_secret', 'refresh_token'), 'post', $inputParams); $authParams = AuthServer::getParam(array('client_id', 'client_secret', 'refresh_token'), 'post', $inputParams);

9
src/OAuth2/Storage/ClientInterface.php
View File

@ -1,4 +1,13 @@
<?php <?php
/**
* OAuth 2.0 Client storage interface
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
namespace OAuth2\Storage; namespace OAuth2\Storage;

9
src/OAuth2/Storage/ScopeInterface.php
View File

@ -1,4 +1,13 @@
<?php <?php
/**
* OAuth 2.0 Scope storage interface
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
namespace OAuth2\Storage; namespace OAuth2\Storage;

70
src/OAuth2/Storage/SessionInterface.php
View File

@ -1,4 +1,13 @@
<?php <?php
/**
* OAuth 2.0 Session storage interface
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
namespace OAuth2\Storage; namespace OAuth2\Storage;
@ -16,15 +25,16 @@ interface SessionInterface
* $accessToken, $stage, UNIX_TIMESTAMP(NOW()), UNIX_TIMESTAMP(NOW())) * $accessToken, $stage, UNIX_TIMESTAMP(NOW()), UNIX_TIMESTAMP(NOW()))
* </code> * </code>
* *
* @param string $clientId The client ID * @param string $clientId The client ID
* @param string $redirectUri The redirect URI * @param string $redirectUri The redirect URI
* @param string $type The session owner's type (default = "user") * @param string $type The session owner's type (default = "user")
* @param string $typeId The session owner's ID (default = "null") * @param string $typeId The session owner's ID (default = "null")
* @param string $authCode The authorisation code (default = "null") * @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null") * @param string $accessToken The access token (default = "null")
* @param string $refreshToken The refresh token (default = "null") * @param string $refreshToken The refresh token (default = "null")
* @param string $stage The stage of the session (default ="request") * @param int $accessTokenExpire The expiry time of an access token as a unix timestamp
* @return int The session ID * @param string $stage The stage of the session (default ="request")
* @return int The session ID
*/ */
public function createSession( public function createSession(
$clientId, $clientId,
@ -49,11 +59,12 @@ interface SessionInterface
* id = $sessionId * id = $sessionId
* </code> * </code>
* *
* @param string $sessionId The session ID * @param string $sessionId The session ID
* @param string $authCode The authorisation code (default = "null") * @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null") * @param string $accessToken The access token (default = "null")
* @param string $refreshToken The refresh token (default = "null") * @param string $refreshToken The refresh token (default = "null")
* @param string $stage The stage of the session (default ="request") * @param int $accessTokenExpire The expiry time of an access token as a unix timestamp
* @param string $stage The stage of the session (default ="request")
* @return void * @return void
*/ */
public function updateSession( public function updateSession(
@ -125,6 +136,29 @@ interface SessionInterface
$authCode $authCode
); );
/**
* Validate an access token
*
* Example SQL query:
*
* <code>
* SELECT id, owner_id, owner_type FROM oauth_sessions WHERE access_token = $accessToken
* </code>
*
* Response:
*
* <code>
* Array
* (
* [id] => (int) The session ID
* [owner_type] => (string) The owner type
* [owner_id] => (string) The owner ID
* )
* </code>
*
* @param [type] $accessToken [description]
* @return [type] [description]
*/
public function validateAccessToken($accessToken); public function validateAccessToken($accessToken);
/** /**
@ -142,6 +176,12 @@ interface SessionInterface
*/ */
public function getAccessToken($sessionId); public function getAccessToken($sessionId);
/**
* Validate a refresh token
* @param string $refreshToken The refresh token
* @param string $clientId The client ID
* @return int The session ID
*/
public function validateRefreshToken($refreshToken, $clientId); public function validateRefreshToken($refreshToken, $clientId);
/** /**
@ -174,7 +214,7 @@ interface SessionInterface
* </code> * </code>
* *
* @param int $sessionId The session ID * @param int $sessionId The session ID
* @param string $scope The scope ID * @param string $scopeId The scope ID
* @return void * @return void
*/ */
public function associateScope($sessionId, $scopeId); public function associateScope($sessionId, $scopeId);

19
src/OAuth2/Util/RedirectUri.php
View File

@ -1,9 +1,28 @@
<?php <?php
/**
* OAuth 2.0 Redirect URI generator
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
namespace OAuth2\Util; namespace OAuth2\Util;
/**
* RedirectUri class
*/
class RedirectUri 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 = array(), $queryDelimeter = '?') public static function make($uri, $params = array(), $queryDelimeter = '?')
{ {
$uri .= (strstr($uri, $queryDelimeter) === false) ? $queryDelimeter : '&'; $uri .= (strstr($uri, $queryDelimeter) === false) ? $queryDelimeter : '&';

17
src/OAuth2/Util/SecureKey.php
View File

@ -1,9 +1,26 @@
<?php <?php
/**
* OAuth 2.0 Secure key generator
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
namespace OAuth2\Util; namespace OAuth2\Util;
/**
* SecureKey class
*/
class SecureKey class SecureKey
{ {
/**
* Generate a new unique code
* @param integer $len Length of the generated code
* @return string
*/
public static function make($len = 40) public static function make($len = 40)
{ {
// We generate twice as many bytes here because we want to ensure we have // We generate twice as many bytes here because we want to ensure we have