Compare commits

..

20 Commits
0.3.1 ... 0.3.5

Author SHA1 Message Date
Alex Bilbie
41d8a1efa3 Merge branch 'release/0.3.5' 2012-12-12 11:44:56 +00:00
Alex Bilbie
4928221b49 Version bump 2012-12-12 11:44:51 +00:00
Alex Bilbie
8131d5be90 Merge branch 'hotfix/resourceConfig' into develop 2012-12-12 11:44:04 +00:00
Alex Bilbie
a948335e45 Merge branch 'hotfix/resourceConfig' 2012-12-12 11:43:11 +00:00
Alex Bilbie
aa978d3581 Fix variable name 2012-12-12 11:43:01 +00:00
Alex Bilbie
b1d91f33cf Merge branch 'release/0.3.4' into develop 2012-12-11 15:33:20 +00:00
Alex Bilbie
1be25955d6 Merge branch 'release/0.3.4' 2012-12-11 15:33:05 +00:00
Alex Bilbie
3365953257 Version bump 2012-12-11 15:32:27 +00:00
Alex Bilbie
302bf1f70d Clean trailing whitespace 2012-12-11 15:31:42 +00:00
Alex Bilbie
6553fb3f22 Return client details 2012-12-11 12:09:56 +00:00
Alex Bilbie
fdfe80289a Merge branch 'release/0.3.3'. Release version 0.3.3
Conflicts:
	composer.json
2012-12-10 21:31:58 +00:00
Alex Bilbie
0ed6674ceb Version bump. Fixed website 2012-12-10 21:31:08 +00:00
Alex Bilbie
912cd3fa25 Changed session stage to 'requested' as per enum 2012-12-10 21:19:11 +00:00
Alex Bilbie
a5b83c00bd Version bump 2012-11-20 15:29:43 +00:00
Alex Bilbie
129c9a7b7a Version bump 2012-11-20 15:28:48 +00:00
Alex Bilbie
958eab33a7 Lots of small documentation updates and clarifications 2012-11-20 15:27:33 +00:00
Alex Bilbie
fead044830 Spacing fixes and fixed sessionScopes() example query 2012-11-20 15:27:15 +00:00
Alex Bilbie
21f48c0491 Spacing updates 2012-11-20 15:26:04 +00:00
Alex Bilbie
ac990b609a Fixed client_id column length 2012-11-16 16:40:01 +00:00
Alex Bilbie
b2188514d9 Merge branch 'release/0.3' into develop 2012-10-14 17:21:04 +01:00
7 changed files with 234 additions and 257 deletions

View File

@@ -1,7 +1,7 @@
{
"name": "lncd/oauth2",
"description": "OAuth 2.0 Framework",
"version": "0.3.1",
"version": "0.3.5",
"homepage": "https://github.com/lncd/OAuth2",
"license": "MIT",
"require": {
@@ -29,7 +29,7 @@
{
"name": "Alex Bilbie",
"email": "hello@alexbilbie.com",
"homepage": "http://www.httpster.org",
"homepage": "http://www.alexbilbie.com",
"role": "Developer"
}
],

View File

@@ -20,7 +20,7 @@ CREATE TABLE `client_endpoints` (
-- Create syntax for TABLE 'oauth_sessions'
CREATE TABLE `oauth_sessions` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`client_id` varchar(32) NOT NULL DEFAULT '',
`client_id` varchar(40) NOT NULL DEFAULT '',
`redirect_uri` varchar(250) NOT NULL DEFAULT '',
`owner_type` enum('user','client') NOT NULL DEFAULT 'user',
`owner_id` varchar(255) DEFAULT NULL,

View File

@@ -6,30 +6,42 @@ interface Database
{
/**
* Validate a client
*
*
* Database query:
*
*
* <code>
* # Client ID + redirect URI
* SELECT clients.id FROM clients LEFT JOIN client_endpoints ON
* client_endpoints.client_id = clients.id WHERE clients.id = $clientId AND
* client_endpoints.redirect_uri = $redirectUri
*
*
* # Client ID + client secret
* SELECT clients.id FROM clients WHERE clients.id = $clientId AND
* clients.secret = $clientSecret
*
*
* # Client ID + client secret + redirect URI
* SELECT clients.id FROM clients LEFT JOIN client_endpoints ON
* client_endpoints.client_id = clients.id WHERE clients.id = $clientId AND
* clients.secret = $clientSecret AND client_endpoints.redirect_uri =
* $redirectUri
* </code>
*
* @param string $clientId The client's ID
*
* Response:
*
* <code>
* Array
* (
* [client_id] => (string) The client ID
* [client secret] => (string) The client secret
* [redirect_uri] => (string) The redirect URI used in this request
* [name] => (string) The name of the client
* )
* </code>
*
* @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")
* @return [type] [description]
* @param string $redirectUri The client's redirect URI (default = "null")
* @return bool|array Returns false if the validation fails, array on success
*/
public function validateClient(
$clientId,
@@ -39,16 +51,16 @@ interface Database
/**
* Create a new OAuth session
*
*
* Database query:
*
*
* <code>
* INSERT INTO oauth_sessions (client_id, redirect_uri, owner_type,
* owner_id, auth_code, access_token, stage, first_requested, last_updated)
* VALUES ($clientId, $redirectUri, $type, $typeId, $authCode,
* $accessToken, $stage, UNIX_TIMESTAMP(NOW()), UNIX_TIMESTAMP(NOW()))
* </code>
*
*
* @param string $clientId The client ID
* @param string $redirectUri The redirect URI
* @param string $type The session owner's type (default = "user")
@@ -56,7 +68,7 @@ interface Database
* @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null")
* @param string $stage The stage of the session (default ="request")
* @return [type] [description]
* @return int The session ID
*/
public function newSession(
$clientId,
@@ -71,20 +83,20 @@ interface Database
/**
* Update an OAuth session
*
*
* Database query:
*
*
* <code>
* UPDATE oauth_sessions SET auth_code = $authCode, access_token =
* $accessToken, stage = $stage, last_updated = UNIX_TIMESTAMP(NOW()) WHERE
* id = $sessionId
* </code>
*
*
* @param string $sessionId The session ID
* @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null")
* @param string $stage The stage of the session (default ="request")
* @return void
* @return void
*/
public function updateSession(
$sessionId,
@@ -96,16 +108,16 @@ interface Database
/**
* Delete an OAuth session
*
*
* <code>
* DELETE FROM oauth_sessions WHERE client_id = $clientId AND owner_type =
* $type AND owner_id = $typeId
* </code>
*
*
* @param string $clientId The client ID
* @param string $type The session owner's type
* @param string $type The session owner's type
* @param string $typeId The session owner's ID
* @return [type] [description]
* @return void
*/
public function deleteSession(
$clientId,
@@ -115,16 +127,16 @@ interface Database
/**
* Validate that an authorisation code is valid
*
*
* Database query:
*
*
* <code>
* SELECT id FROM oauth_sessions WHERE client_id = $clientID AND
* redirect_uri = $redirectUri AND auth_code = $authCode
* </code>
*
*
* Response:
*
*
* <code>
* Array
* (
@@ -141,12 +153,12 @@ interface Database
* last updated
* )
* </code>
*
*
* @param string $clientId The client ID
* @param string $redirectUri The redirect URI
* @param string $authCode The authorisation code
* @return int|bool Returns the session ID if the auth code
* is valid otherwise returns false
* @return int|bool Returns the session ID if the auth code
* is valid otherwise returns false
*/
public function validateAuthCode(
$clientId,
@@ -156,18 +168,18 @@ interface Database
/**
* Return the session ID for a given session owner and client combination
*
*
* Database query:
*
*
* <code>
* SELECT id FROM oauth_sessions WHERE client_id = $clientId
* AND owner_type = $type AND owner_id = $typeId
* </code>
*
* @param string $type The session owner's type
*
* @param string $type The session owner's type
* @param string $typeId The session owner's ID
* @param string $clientId The client ID
* @return string|null Return the session ID as an integer if
* @return string|null Return the session ID as an integer if
* found otherwise returns false
*/
public function hasSession(
@@ -178,13 +190,13 @@ interface Database
/**
* Return the access token for a given session
*
*
* Database query:
*
*
* <code>
* SELECT access_token FROM oauth_sessions WHERE id = $sessionId
* </code>
*
*
* @param int $sessionId The OAuth session ID
* @return string|null Returns the access token as a string if
* found otherwise returns null
@@ -193,13 +205,13 @@ interface Database
/**
* Removes an authorisation code associated with a session
*
*
* Database query:
*
*
* <code>
* UPDATE oauth_sessions SET auth_code = NULL WHERE id = $sessionId
* </code>
*
*
* @param int $sessionId The OAuth session ID
* @return void
*/
@@ -207,14 +219,14 @@ interface Database
/**
* Sets a sessions access token
*
*
* Database query:
*
*
* <code>
* UPDATE oauth_sessions SET access_token = $accessToken WHERE id =
* UPDATE oauth_sessions SET access_token = $accessToken WHERE id =
* $sessionId
* </code>
*
*
* @param int $sessionId The OAuth session ID
* @param string $accessToken The access token
* @return void
@@ -226,14 +238,14 @@ interface Database
/**
* Associates a session with a scope
*
*
* Database query:
*
*
* <code>
* INSERT INTO oauth_session_scopes (session_id, scope) VALUE ($sessionId,
* INSERT INTO oauth_session_scopes (session_id, scope) VALUE ($sessionId,
* $scope)
* </code>
*
*
* @param int $sessionId The session ID
* @param string $scope The scope
* @return void
@@ -245,15 +257,15 @@ interface Database
/**
* Return information about a scope
*
*
* Database query:
*
*
* <code>
* SELECT * FROM scopes WHERE scope = $scope
* </code>
*
*
* Response:
*
*
* <code>
* Array
* (
@@ -263,22 +275,22 @@ interface Database
* [description] => (string) The scope's description
* )
* </code>
*
*
* @param string $scope The scope
* @return array
* @return array
*/
public function getScope($scope);
/**
* Associate a session's scopes with an access token
*
*
* Database query:
*
*
* <code>
* UPDATE oauth_session_scopes SET access_token = $accessToken WHERE
* UPDATE oauth_session_scopes SET access_token = $accessToken WHERE
* session_id = $sessionId
* </code>
*
*
* @param int $sessionId The session ID
* @param string $accessToken The access token
* @return void
@@ -290,17 +302,17 @@ interface Database
/**
* Return the scopes associated with an access token
*
*
* Database query:
*
*
* <code>
* SELECT scopes.scope, scopes.name, scopes.description FROM
* oauth_session_scopes JOIN scopes ON oauth_session_scopes.scope =
* SELECT scopes.scope, scopes.name, scopes.description FROM
* oauth_session_scopes JOIN scopes ON oauth_session_scopes.scope =
* scopes.scope WHERE access_token = $accessToken
* </code>
*
*
* Response:
*
*
* <code>
* Array
* (
@@ -312,7 +324,7 @@ interface Database
* )
* )
* </code>
*
*
* @param string $accessToken The access token
* @return array
*/

View File

@@ -41,7 +41,7 @@ class Server
private $_responseTypes = array(
'code'
);
/**
* Supported grant types
* @var array
@@ -69,9 +69,9 @@ class Server
/**
* Error codes.
*
*
* To provide i8ln errors just overwrite the keys
*
*
* @var array
*/
public $errors = array(
@@ -89,7 +89,7 @@ class Server
/**
* Constructor
*
*
* @access public
* @param array $options Optional list of options to overwrite the defaults
* @return void
@@ -103,7 +103,7 @@ class Server
/**
* Register a database abstrator class
*
*
* @access public
* @param object $db A class that implements OAuth2ServerDatabase
* @return void
@@ -115,7 +115,7 @@ class Server
/**
* Check client authorise parameters
*
*
* @access public
* @param array $authParams Optional array of parsed $_GET keys
* @return array Authorise request parameters
@@ -132,7 +132,7 @@ class Server
} else {
$params['client_id'] = (isset($authParams['client_id'])) ?
$authParams['client_id'] :
$authParams['client_id'] :
$_GET['client_id'];
}
@@ -163,6 +163,8 @@ class Server
throw new ClientException($this->errors['invalid_client'], 8);
}
$params['client_details'] = $clientDetails;
// Response type
if ( ! isset($authParams['response_type']) && ! isset($_GET['response_type'])) {
@@ -214,7 +216,7 @@ class Server
'getScope',
$scope
);
if ($scopeDetails === false) {
throw new ClientException(sprintf($this->errors['invalid_scope'], $scope), 4);
@@ -231,7 +233,7 @@ class Server
/**
* Parse a new authorise request
*
*
* @param string $type The session owner's type
* @param string $typeId The session owner's ID
* @param array $authoriseParams The authorise request $_GET parameters
@@ -249,10 +251,10 @@ class Server
// Create the new auth code
$authCode = $this->newAuthCode(
$authoriseParams['client_id'],
$authoriseParams['client_id'],
'user',
$typeId,
$authoriseParams['redirect_uri'],
$authoriseParams['redirect_uri'],
$authoriseParams['scopes']
);
@@ -261,9 +263,9 @@ class Server
/**
* Generate a unique code
*
*
* Generate a unique code for an authorisation code, or token
*
*
* @return string A unique code
*/
private function generateCode()
@@ -273,7 +275,7 @@ class Server
/**
* Create a new authorisation code
*
*
* @param string $clientId The client ID
* @param string $type The type of the owner of the session
* @param string $typeId The session owner's ID
@@ -286,7 +288,7 @@ class Server
{
$authCode = $this->generateCode();
// If an access token exists then update the existing session with the
// If an access token exists then update the existing session with the
// new authorisation code otherwise create a new session
if ($accessToken !== null) {
@@ -297,15 +299,15 @@ class Server
$typeId,
$authCode,
$accessToken,
'request'
'requested'
);
} else {
// Delete any existing sessions just to be sure
$this->_dbCall('deleteSession', $clientId, $type, $typeId);
// Create a new session
// Create a new session
$sessionId = $this->_dbCall(
'newSession',
$clientId,
@@ -315,9 +317,9 @@ class Server
$authCode,
null,
null,
'request'
'requested'
);
// Add the scopes
foreach ($scopes as $key => $scope) {
@@ -330,17 +332,17 @@ class Server
}
}
return $authCode;
}
/**
* Issue an access token
*
*
* @access public
*
*
* @param array $authParams Optional array of parsed $_POST keys
*
*
* @return array Authorise request parameters
*/
public function issueAccessToken($authParams = null)
@@ -367,10 +369,10 @@ class Server
switch ($params['grant_type'])
{
case 'authorization_code': // Authorization code grant
return $this->completeAuthCodeGrant($authParams, $params);
break;
break;
case 'refresh_token': // Refresh token
case 'password': // Resource owner password credentials grant
@@ -383,12 +385,12 @@ class Server
/**
* Complete the authorisation code grant
*
*
* @access private
*
*
* @param array $authParams Array of parsed $_POST keys
* @param array $params Generated parameters from issueAccessToken()
*
*
* @return array Authorise request parameters
*/
private function completeAuthCodeGrant($authParams = array(), $params = array())
@@ -436,7 +438,7 @@ class Server
$clientDetails = $this->_dbCall(
'validateClient',
$params['client_id'],
$params['client_secret'],
$params['client_secret'],
$params['redirect_uri']
);
@@ -470,7 +472,7 @@ class Server
if ( ! $session) {
throw new ClientException(sprintf($this->errors['invalid_grant'], 'code'), 9);
} else {
// A session ID was returned so update it with an access token,
@@ -508,16 +510,16 @@ class Server
/**
* Generates the redirect uri with appended params
*
*
* @param string $redirectUri The redirect URI
* @param array $params The parameters to be appended to the URL
* @param string $query_delimeter The query string delimiter (default: ?)
*
*
* @return string The updated redirect URI
*/
public function redirectUri($redirectUri, $params = array(), $queryDelimeter = '?')
{
if (strstr($redirectUri, $queryDelimeter)) {
$redirectUri = $redirectUri . '&' . http_build_query($params);
@@ -527,14 +529,14 @@ class Server
$redirectUri = $redirectUri . $queryDelimeter . http_build_query($params);
}
return $redirectUri;
}
/**
* Call database methods from the abstractor
*
*
* @return mixed The query result
*/
private function _dbCall()

View File

@@ -6,17 +6,17 @@ interface Database
{
/**
* Validate an access token and return the session details.
*
*
* Database query:
*
*
* <code>
* SELECT id, owner_type, owner_id FROM oauth_sessions WHERE access_token =
* $accessToken AND stage = 'granted' AND
* access_token_expires > UNIX_TIMESTAMP(now())
* </code>
*
*
* Response:
*
*
* <code>
* Array
* (
@@ -25,7 +25,7 @@ interface Database
* [owner_id] => (string) The session owner's ID
* )
* </code>
*
*
* @param string $accessToken The access token
* @return array|bool Return an array on success or false on failure
*/
@@ -33,16 +33,16 @@ interface Database
/**
* Returns the scopes that the session is authorised with.
*
*
* Database query:
*
*
* <code>
* SELECT scope FROM oauth_session_scopes WHERE access_token =
* '291dca1c74900f5f252de351e0105aa3fc91b90b'
* SELECT scope FROM oauth_session_scopes WHERE session_id =
* $sessionId
* </code>
*
*
* Response:
*
*
* <code>
* Array
* (
@@ -51,7 +51,7 @@ interface Database
* ...
* )
* </code>
*
*
* @param int $sessionId The session ID
* @return array A list of scopes
*/

View File

@@ -75,7 +75,7 @@ class Server
public function __construct($options = null)
{
if ($options !== null) {
$this->config = array_merge($this->config, $options);
$this->_config = array_merge($this->_config, $options);
}
}

View File

@@ -23,169 +23,132 @@ class OAuthdb implements Database
'description' => 'test'
));
public function validateClient(
$clientId,
$clientSecret = null,
$redirectUri = null
)
{
if ($clientId !== $this->clients[0]['client_id'])
{
return false;
}
public function validateClient($clientId, $clientSecret = null, $redirectUri = null)
{
if ($clientId !== $this->clients[0]['client_id'])
{
return false;
}
if ($clientSecret !== null && $clientSecret !== $this->clients[0]['client_secret'])
{
return false;
}
if ($clientSecret !== null && $clientSecret !== $this->clients[0]['client_secret'])
{
return false;
}
if ($redirectUri !== null && $redirectUri !== $this->clients[0]['redirect_uri'])
{
return false;
}
if ($redirectUri !== null && $redirectUri !== $this->clients[0]['redirect_uri'])
{
return false;
}
return $this->clients[0];
}
return $this->clients[0];
}
public function newSession(
$clientId,
$redirectUri,
$type = 'user',
$typeId = null,
$authCode = null,
$accessToken = null,
$accessTokenExpire = null,
$stage = 'requested'
)
{
$id = count($this->sessions);
public function newSession($clientId, $redirectUri, $type = 'user', $typeId = null, $authCode = null, $accessToken = null, $accessTokenExpire = null, $stage = 'requested')
{
$id = count($this->sessions);
$this->sessions[$id] = array(
'id' => $id,
'client_id' => $clientId,
'redirect_uri' => $redirectUri,
'owner_type' => $type,
'owner_id' => $typeId,
'auth_code' => $authCode,
'access_token' => $accessToken,
'access_token_expire' => $accessTokenExpire,
'stage' => $stage
);
$this->sessions[$id] = array(
'id' => $id,
'client_id' => $clientId,
'redirect_uri' => $redirectUri,
'owner_type' => $type,
'owner_id' => $typeId,
'auth_code' => $authCode,
'access_token' => $accessToken,
'access_token_expire' => $accessTokenExpire,
'stage' => $stage
);
$this->sessions_client_type_id[$clientId . ':' . $type . ':' . $typeId] = $id;
$this->sessions_code[$clientId . ':' . $redirectUri . ':' . $authCode] = $id;
$this->sessions_client_type_id[$clientId . ':' . $type . ':' . $typeId] = $id;
$this->sessions_code[$clientId . ':' . $redirectUri . ':' . $authCode] = $id;
return true;
}
return $id;
}
public function updateSession(
$sessionId,
$authCode = null,
$accessToken = null,
$accessTokenExpire = null,
$stage = 'requested'
)
{
$this->sessions[$sessionId]['auth_code'] = $authCode;
$this->sessions[$sessionId]['access_token'] = $accessToken;
$this->sessions[$sessionId]['access_token_expire'] = $accessTokenExpire;
$this->sessions[$sessionId]['stage'] = $stage;
public function updateSession($sessionId, $authCode = null, $accessToken = null, $accessTokenExpire = null, $stage = 'requested')
{
$this->sessions[$sessionId]['auth_code'] = $authCode;
$this->sessions[$sessionId]['access_token'] = $accessToken;
$this->sessions[$sessionId]['access_token_expire'] = $accessTokenExpire;
$this->sessions[$sessionId]['stage'] = $stage;
return true;
}
return true;
}
public function deleteSession(
$clientId,
$type,
$typeId
)
{
$key = $clientId . ':' . $type . ':' . $typeId;
if (isset($this->sessions_client_type_id[$key]))
{
unset($this->sessions[$this->sessions_client_type_id[$key]]);
}
return true;
}
public function deleteSession($clientId, $type, $typeId)
{
$key = $clientId . ':' . $type . ':' . $typeId;
if (isset($this->sessions_client_type_id[$key]))
{
unset($this->sessions[$this->sessions_client_type_id[$key]]);
}
return true;
}
public function validateAuthCode(
$clientId,
$redirectUri,
$authCode
)
{
$key = $clientId . ':' . $redirectUri . ':' . $authCode;
public function validateAuthCode($clientId, $redirectUri, $authCode)
{
$key = $clientId . ':' . $redirectUri . ':' . $authCode;
if (isset($this->sessions_code[$key]))
{
return $this->sessions[$this->sessions_code[$key]];
}
if (isset($this->sessions_code[$key]))
{
return $this->sessions[$this->sessions_code[$key]];
}
return false;
}
return false;
}
public function hasSession(
$type,
$typeId,
$clientId
)
{
die('not implemented hasSession');
}
public function hasSession($type, $typeId, $clientId)
{
die('not implemented hasSession');
}
public function getAccessToken($sessionId)
{
die('not implemented getAccessToken');
}
public function getAccessToken($sessionId)
{
die('not implemented getAccessToken');
}
public function removeAuthCode($sessionId)
{
die('not implemented removeAuthCode');
}
public function removeAuthCode($sessionId)
{
die('not implemented removeAuthCode');
}
public function setAccessToken(
$sessionId,
$accessToken
)
{
die('not implemented setAccessToken');
}
public function setAccessToken(
$sessionId,
$accessToken
)
{
die('not implemented setAccessToken');
}
public function addSessionScope(
$sessionId,
$scope
)
{
if ( ! isset($this->session_scopes[$sessionId]))
{
$this->session_scopes[$sessionId] = array();
}
public function addSessionScope($sessionId, $scope)
{
if ( ! isset($this->session_scopes[$sessionId]))
{
$this->session_scopes[$sessionId] = array();
}
$this->session_scopes[$sessionId][] = $scope;
$this->session_scopes[$sessionId][] = $scope;
return true;
}
return true;
}
public function getScope($scope)
{
if ( ! isset($this->scopes[$scope]))
{
return false;
}
public function getScope($scope)
{
if ( ! isset($this->scopes[$scope]))
{
return false;
}
return $this->scopes[$scope];
}
return $this->scopes[$scope];
}
public function updateSessionScopeAccessToken(
$sessionId,
$accessToken
)
{
return true;
}
public function updateSessionScopeAccessToken($sessionId, $accessToken)
{
return true;
}
public function accessTokenScopes($accessToken)
{
die('not implemented accessTokenScopes');
}
public function accessTokenScopes($accessToken)
{
die('not implemented accessTokenScopes');
}
}